Clarify release stages on "releases" page #2233
Merged
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
|
This is a very nice addition to the docs, would help alot with people starting out and overall frustration when it comes to node versioning. |
dominykas
reviewed
May 15, 2019
dominykas
reviewed
May 15, 2019
mgol
reviewed
May 15, 2019
fhemberger
suggested changes
May 16, 2019
Trott
reviewed
May 16, 2019
|
/ping @nodejs/release |
|
Sorry to hear that the release info wasn't clear and caused issues for your team. Help on making that information more available and more clear is certainly appreciated. |
|
Thanks, @mgol, @fhemberger, and @Trott. I replaced "Node" with "Node.js", added the qualification that releases are "typically" LTS for 30 months, and moved the paragraph from the template to the localized md file. That makes it appear at the top of the page rather than the bottom, but that doesn't seem like a problem. |
fhemberger
suggested changes
May 17, 2019
Trott
reviewed
May 17, 2019
Trott
reviewed
May 17, 2019
My team recently did our first major Node version upgrade and had a bad experience. The short version is: we tried to upgrade to Node 12 (which is in "Current" status as of today, not "Active"). We couldn't get one of our dependencies to build and ended the workday without successfully upgrading. I'd seen the [releases](https://nodejs.org/en/about/releases/) page multiple times, including during that attempted upgrade. However, that page doesn't explain what the various stages actually mean, and which ones are recommended for production use. Specifically, I didn't understand "Current" vs. "Active", and incorrectly assumed that either would be acceptable for production use, because neither of them was called "unstable", "testing", "alpha", "beta", "prerelease", or other terms that I'm familiar with for a "don't use this in production app yet!" release. This change adds a paragraph with a brief explanation of the different statuses. I also included a bit about LTS, because I imagine a lot of people seeing this page won't be familiar with that term. I think that a short explanation on the releases page will save a lot of other teams from this kind of multi-hour upgrade frustration. I've never contributed to this repo, so I may have put this text in the wrong file, and my explanation of the Node release statuses may be wrong in ways I don't understand yet. But I wanted to suggest a concrete change that would've helped us to avoid wasting half of a day. (My understanding is based on this @jasnell tweet: https://twitter.com/jasnell/status/1128696625986015232.)
fhemberger
approved these changes
May 21, 2019
|
Thank you! |
|
Thanks for merging! 👍 |
SEWeiTung
added a commit
that referenced
this pull request
Sep 20, 2019
This is the translation for the comments of release.md. Ref：#2233.
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.
My team recently did our first major Node version upgrade and had a bad experience. The short version is: we tried to upgrade to Node 12 (which is in "Current" status as of today, not "Active"). We couldn't get one of our dependencies to build and ended the workday without successfully upgrading.
I'd seen the releases page multiple times, including during that attempted upgrade. However, that page doesn't explain what the various stages actually mean, and which ones are recommended for production use. Specifically, I didn't understand "Current" vs. "Active", and incorrectly assumed that either would be acceptable for production use, because neither of them was called "unstable", "testing", "alpha", "beta", "prerelease", or other terms that I'm familiar with for a "don't use this in production app yet!" release.
This change adds a paragraph with a brief explanation of the different statuses. I also included a bit about LTS, because I imagine a lot of people seeing this page won't be familiar with that term.
I think that a short explanation on the releases page will save a lot of other teams from this kind of multi-hour upgrade frustration. I've never contributed to this repo, so I may have put this text in the wrong file, and my explanation of the Node release statuses may be wrong in ways I don't understand yet. But I wanted to suggest a concrete change that would've helped us to avoid wasting half of a day.
(My understanding is based on this @jasnell tweet: https://twitter.com/jasnell/status/1128696625986015232.)