docs: reword Yarn v1 bundling descriptions for Node.js 26 release#2483
docs: reword Yarn v1 bundling descriptions for Node.js 26 release#2483MikeMcC399 wants to merge 1 commit intonodejs:mainfrom
Conversation
|
Requires #2484 to pass link checking |
488fe4e to
c264490
Compare
|
Rebased to fix markdown-link-check issues |
| New **npm** releases are not tracked. We simply use the npm version bundled in the corresponding Node.js release. | ||
|
|
||
| **[Yarn v1 Classic](https://classic.yarnpkg.com/)** is no longer maintained upstream, and will be removed starting with the Node 26 images. | ||
| **[Yarn v1 Classic](https://classic.yarnpkg.com/)** is no longer maintained upstream, and it is removed when constructing Dockerfiles |
There was a problem hiding this comment.
Would it be better to say "is not longer included" with Node 26 and above as opposed to saying "it is removed"? Otherwise LGTM
There was a problem hiding this comment.
I wrote it like that because this is the documentation for contributors who I expect to be more concerned about internal processes and script workings.
The templates like Dockerfile-debian.template include a section which installs Yarn. When the update.sh script runs, it removes this Yarn installation section when it constructs a Dockerfile like 26/trixie/Dockerfile for a Node.js version >=26. The net result is that the Dockerfile doesn't install Yarn.
The README document words it differently and doesn't talk about anything being removed because only the end-result is relevant for the end-consumer of the Docker images.
It would be possible to take out that level of detail here if you think it would be confusing. I'd prefer to leave it as it is though to give possible contributors better insight into internals. Perhaps I should just add in the description I've given to you as explanation?
Description
Reword bundling descriptions regarding Yarn v1 in the documents:
Motivation and Context
The README document, including the section Yarn v1 Classic bundling is written as a statement of plans and preparation for Node.js 26 and above.
With the release of Node.js 26, the implementation dropping Yarn v1 Classic is now realized.
Testing Details
N/A
Example Output (if appropriate)
N/A
Types of changes
Checklist