doc: improve Download section of README #23212
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Simplify and clarify text in the Download section of the README file.
lpinca
approved these changes
Oct 2, 2018
vsemozhetbyt
approved these changes
Oct 2, 2018
vsemozhetbyt
added
the
author ready
benjamingr
approved these changes
Oct 2, 2018
|
After this PR the section looks like: Some of it seemed redundant to me, so I made a suggestion that looks like: |
refack
removed
the
author ready
richardlau
requested changes
Oct 2, 2018
README.md
Outdated
| documentation of the latest stable version. | ||
| <https://nodejs.org/api/> | ||
|
|
||
| Points to the API documentation of the latest LTS release. |
There was a problem hiding this comment.
This currently points to Node.js v10.11.0 docs, which is the latest current release, so I don't think it's correct to say it points to the latest LTS release.
README.md
Outdated
|
|
||
| Points to the API documentation of the latest LTS release. | ||
| Version specific documentation are avalible in each release and nightly | ||
| directory under _docs_. |
There was a problem hiding this comment.
Replace _docs_ with https://nodejs.org/download/docs/?
richardlau
reviewed
Oct 2, 2018
README.md
Outdated
| <https://nodejs.org/download/nightly/> | ||
|
|
||
| Release names are appeded a version string that includes the date (in UTC time) | ||
| and the 10 first characters of the commit SHA at the HEAD of the release. |
There was a problem hiding this comment.
Typo appeded -> appended with.
There was a problem hiding this comment.
On reflection I think I prefer the original text. The reworded text is a little more awkward to read and adds more technical specifics for no added value.
richardlau
approved these changes
Oct 2, 2018
Trott
added
the
author ready
jasnell
approved these changes
Oct 2, 2018
|
Landed in cd40d7a |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Oct 4, 2018
Simplify and clarify text in the Download section of the README file. PR-URL: nodejs#23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
targos
pushed a commit
that referenced
this pull request
Oct 4, 2018
Simplify and clarify text in the Download section of the README file. PR-URL: #23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
This was referenced Oct 10, 2018
This was referenced Oct 11, 2018
jasnell
pushed a commit
that referenced
this pull request
Oct 17, 2018
Simplify and clarify text in the Download section of the README file. PR-URL: #23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Simplify and clarify text in the Download section of the README file.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes