Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: put landing specifics in details tag #35296

Merged
merged 1 commit into from
Sep 25, 2020
Merged

doc: put landing specifics in details tag #35296

merged 1 commit into from
Sep 25, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 22, 2020 •
edited
Loading

Showing all the steps isn't usually useful and in makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 22, 2020
mhdawson
mhdawson approved these changes Sep 22, 2020
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Trott
doc: revise introductory child_process text
52dd524 
This consolidates information about Windows environment variables and
has a few other smaller improvements (punctuation, present tense, etc.).

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: nodejs#35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@Trott Trott merged commit 52dd524 into nodejs:master Sep 25, 2020
@Trott Trott deleted the details-collab-guide branch September 25, 2020 14:44
@Trott
Copy link
Member Author

Trott commented Sep 25, 2020

Whoops, I messed up and landed the wrong thing. Force pushed it out, but now this says it's merged. Will try to recover it and land it properly....

Trott added a commit that referenced this pull request Sep 25, 2020
@Trott
doc: put landing specifics in details tag
895832c 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: #35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@Trott
Copy link
Member Author

Trott commented Sep 25, 2020

Landed in 895832c

MylesBorins pushed a commit that referenced this pull request Sep 29, 2020
@Trott @MylesBorins
doc: put landing specifics in details tag
a8d3a7f 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: #35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Sep 29, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Nov 3, 2020
@Trott @MylesBorins
doc: put landing specifics in details tag
40ca80b 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: #35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Nov 3, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Nov 16, 2020
@Trott @MylesBorins
doc: put landing specifics in details tag
77555d8 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: #35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@Trott @joesepi
doc: put landing specifics in details tag
701e9a7 
Showing all the steps isn't usually useful and makes it seem like the
collaborator is meant to follow the manual steps. I've seen this happen
during at least one onboarding. The section is also a bit long to
comfortably scroll over quickly to find the next section.

Let's put those steps in a details block to make it more obvious that it
is there for unusual situations only.

Co-authored-by: Shelley Vohr <[email protected]>

PR-URL: nodejs#35296
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codebytere codebytere codebytere left review comments

@mhdawson mhdawson mhdawson approved these changes

@richardlau richardlau richardlau approved these changes

@targos targos targos approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Trott @nodejs-github-bot @codebytere @targos @richardlau @mhdawson