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.

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

doc: update the Troubleshooting section of the Collaborator Guide #26652

Closed
wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Mar 14, 2019

Some changes to keep things simple and direct.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Trott added 2 commits March 13, 2019 20:10
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 14, 2019
@Trott
Copy link
Member Author

Trott commented Mar 14, 2019

(Change to the git hint: text is a copy/paste from a more recent git than what was used to generate the original message in the doc. I'm using git 2.14.2.)

hint: to the same ref. You may want to first integrate the remote changes
hint: (e.g. 'git pull ...') before pushing again.
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Integrate the remote changes (e.g.
Copy link
Member

Choose a reason for hiding this comment

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

The new description is definitely on the point and correct but the former one seems easier to understand or at least to me, it seems the former version required less knowledge about git. I personally would stick to the former version for the first sentence.

Copy link
Member Author

Choose a reason for hiding this comment

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

How about just removing all the hint text and leaving lines 603-605? That's the relevant part anyway. The hint text will be whatever and we don't control it.

Copy link
Member

Choose a reason for hiding this comment

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

Looking at it again: I just realized this is 1-to-1 the actual git hint. Therefore it's probably indeed good to use that.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 14, 2019
@vsemozhetbyt vsemozhetbyt added the meta Issues and PRs related to the general management of the project. label Mar 14, 2019
@Trott
Copy link
Member Author

Trott commented Mar 16, 2019

Landed in 5a23a87...22de2cf

@Trott Trott closed this Mar 16, 2019
Trott added a commit to Trott/io.js that referenced this pull request Mar 16, 2019
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.

PR-URL: nodejs#26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Trott added a commit to Trott/io.js that referenced this pull request Mar 16, 2019
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.

PR-URL: nodejs#26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
targos pushed a commit to targos/node that referenced this pull request Mar 27, 2019
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.

PR-URL: nodejs#26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
targos pushed a commit to targos/node that referenced this pull request Mar 27, 2019
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.

PR-URL: nodejs#26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
targos pushed a commit that referenced this pull request Mar 27, 2019
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.

PR-URL: #26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
targos pushed a commit that referenced this pull request Mar 27, 2019
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.

PR-URL: #26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
BethGriggs pushed a commit that referenced this pull request Apr 17, 2019
In the Troubleshooting portion of the Collaborator Guide, there is a
copy/pasted error message. The message is out of date. More recent git
contains a more concise and clear message. Update the text to reflect
the current git error message.

PR-URL: #26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
BethGriggs pushed a commit that referenced this pull request Apr 17, 2019
In the Troubleshooting section of the Collaborator Guide, there is one
particularly lengthy and difficult-to-understand sentence. Make it
shorter and more clear.

PR-URL: #26652
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
@BethGriggs BethGriggs mentioned this pull request May 1, 2019
@Trott Trott deleted the troubleshooting branch January 13, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants