fix(learn): env var tutorial link to latest docs #7996
Conversation
Adjust the link in the "How to read environment variables from Node.js" tutorial to refer to the latest version of the API docs and not arbitrarily link to Node.js 22's docs. Fixes nodejs#7995
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
apps/site/pages/en/learn/command-line/how-to-read-environment-variables-from-nodejs.md
Show resolved
Hide resolved
There was a problem hiding this comment.
Adjust the link in the "How to read environment variables from Node.js" tutorial to refer to the latest version of the API docs and not an arbitrarily link to Node.js 22's docs.
No it's not arbitrary. It's voluntary done in #7307
Why ? Because maintaining the learn section is complicated. So do not have broken docs/exmaple we decide to ping it to a version. this sub section use 22
Why not update it to 24 but you have to verify everything.
Also for more context take a look at https://nodejs.org/en/blog/events/collab-summit-2024-dublin#documentation-improvements-nodejs-learn-section
|
I disagree. We should always use the latest version of the documentation. The articles should be updated over time, yes, but we shouldn't assume the user is on a version that isn't the latest. |
|
My idea at the time, but I never tried to implement it, was to have a semver range in the frontmatter of the display in some way in the metabar. And then to have an MDX component that links the docs.
I would like to think like you, but to apply that, Node would have to have no breaking changes or deprecations. |
Description
Adjust the link in the "How to read environment variables from Node.js" tutorial to refer to the latest version of the API docs and not an arbitrarily link to Node.js 22's docs.
Validation
Click on the link in the "How to read environment variables from Node.js" article and see it directs to the latest API docs.
Related Issues
Fixes #7995
Check List
pnpm formatto ensure the code follows the style guide.pnpm testto check if all tests are passing.pnpm buildto check if the website builds without errors.