-
Notifications
You must be signed in to change notification settings - Fork 31.2k
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: remove Corepack documentation page #57663
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #57663 +/- ##
=======================================
Coverage 90.23% 90.24%
=======================================
Files 630 630
Lines 185055 185055
Branches 36221 36222 +1
=======================================
+ Hits 166984 166995 +11
+ Misses 11043 11036 -7
+ Partials 7028 7024 -4 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Corepack is available in 24.x, and removal of documentation page will create confusion among its existing users. And they may not try experimental features of Node.js again.
The documentation page already links to npm package. We can update it to mention about upcoming removal in v25+ and remove the documentation in v25+.
@trivikr you can add the |
I would like to see the URL https://nodejs.org/docs/latest/api/corepack.html returning a useful short statement until Node.js 24.x reaches its EOL in April 2028. It seems inconsistent to remove the documentation page when the bundled content is still being shipped. If I understood the impact of this PR correctly it would mean https://nodejs.org/docs/latest/api/corepack.html returns a 404 error after the release of Node.js 24.0.0 in April 2025. Even when Node.js 25.x is released I would still like to see a working placeholder under the |
That's debatable, we've never shipped any documentation for npm, having one for Corepack is arguably what's inconsistent. |
I added
That's true. There are links to corepack documentation in the wild which point to the latest version of the doc in Node.js. And whoever lands on that page should get to know how they can continue using corepack. A 404 page will lead to loss of trust in any experimental features which Node.js introduces (current and future). |
Would that be a bad thing? IMO users should not trust experimental features. |
It's the trust wrt communication, and it can apply to stable features too. Explaining it with an example makes it clear:
When v24 releases on 2025-04-22 with 404 for corepack documentation
The action after losing trust can be any of the following:
|
That's not going to happen though, this PR has the
dont-land-on-v24.x
|
I liked this suggestion from @MikeMcC399 after my vote though
This will help folks landing on corepack documentation from links shared in the ecosystem.
I think v27+ would be a good midway choice, but v26+ is also okay. |
Corepack has been removed from |
Following up on #57635, let's remove the page. Adding dont-land labels as a cautionary step to avoid 404 in case there are links in the wild to that page. Landing it on 24.x should be fine as long as it lands before 24.0.0.