-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
content(userland-migration): make up to date
#8053
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Pull Request Overview
Updates the userland-migration documentation to reflect current status and showcase new codemods for Node.js version migrations and ecosystem transitions.
- Reorganizes navigation structure from "migrations" to "userland-migrations" for consistency
- Adds comprehensive documentation for v20-to-v22 and v14-to-v16 migration codemods
- Introduces ecosystem migration documentation for transitioning from external tools to native Node.js features
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/i18n/src/locales/en.json | Updates navigation labels and adds new migration page entries |
| apps/site/pages/en/learn/userland-migrations/v20-to-v22.md | Documents import assertions to attributes codemod for Node.js v22 migration |
| apps/site/pages/en/learn/userland-migrations/v14-to-v16.md | Documents createRequire and rmdir codemods for Node.js v16 migration |
| apps/site/pages/en/learn/userland-migrations/introduction.md | Enhanced introduction with comprehensive usage guide and best practices |
| apps/site/pages/en/learn/userland-migrations/ecosystem.md | Documents TypeScript specifier correction codemod for ecosystem migration |
| apps/site/pages/en/learn/migrations/introduction.md | Removes old migration documentation file |
| apps/site/navigation.json | Updates navigation structure to use new userland-migrations path and adds new pages |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8053 +/- ##
==========================================
- Coverage 76.62% 76.61% -0.02%
==========================================
Files 117 117
Lines 9751 9746 -5
Branches 328 328
==========================================
- Hits 7472 7467 -5
Misses 2277 2277
Partials 2 2 ☔ View full report in Codecov by Sentry. |
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.
Did a cursory review. There's definitely a lot of work to be done before this can land, so I'm blocking for now.
Olay i had opened the pr to have review on structure/aproeach |
|
@avivkeller I have a compromise to propose. We will proceed with this file structure even if you are not satisfied with it. We will then reopen issue #7267 and find a long-term solution for where to store these documents. |
|
I'm still strongly -1 on articles for specific Codemods. Those should be blog posts, if anything. cc @nodejs/nodejs-website @nodejs/marketing for opinions |
If I'm understanding right, the current article(s) are listing specific codemods as part of a major node migration, which means that list will be frozen once complete. That seems okay to me, but perhaps redundant: I would instead just list/link to the major migration recipe, which will itself list the individual migrations anyway. P.S. I think we definitely should not statically list all migrations available. That would be an untenable maintenance burden, and we already have tools (github, the codemod registry, and perhaps others) that do it well already. |
|
@avivkeller other solution using doc-kit with web generator on
|
|
I'm neutral here, but agree that codemods are something more "temporal", so I agree with the notion of this being better suited for a blog post? |
In theory, yes. But in our case, it doesn't work because a blog post is read once by the user when it is published (from a post on the RSS feed network). But here, we haven't yet completed all the migrations to cover a complete version, so once they've read it, they won't come back to the post even if new codemod is added to it. And frankly, we need visibility to help with adoption so that we can then get feedback. |
5a6d2f6 to
e98d32d
Compare
|
Hello @nodejs/tsc, I would like to hear your opinion on the situation. This PR updates the resource on userland-migrations to include everything that has been produced by the initiative and introduces a new page. And @avivkeller blocks the idea with the following argument I am linking to the message so as not to paraphrase it
So the question that arises is, "Where should we put the migration guides?" Option 1: Learn section Option 2: blog category Option 3: dedicated section Option 4: dedicated website |
|
@AugustinMauroy in the future, before escalating to the technical steering committee, we can always have a web team meeting. However, I maintain my stance that these should not be articles. An article for every code mod released is not a viable solution. Rather, I think, a single article linking to the code mod repository, where those lists can be maintained is better. A code mod here and there could also be a blog post, again, without the need of individual learn articles for specific code mods. |
|
A fifth option, that is, have a single learn articles explaining the code mods, and linking to the dedicated repository, would best, imo. |
FYI: I first asked Ruy (because he speaks French, to avoid the language barrier) if it was worth pinging the TSC. And I also didn't add it to the TSC agenda for a formal vote, just to ask for their opinion/feelings. Furthermore, if I am not mistaken, at the moment the website team is not responsible for the content, so it makes sense to me not to put it in our agenda.
I don't get what you mean on this point. I don't think I wrote an article per codemod. I wrote migration guides per version and one for the ecosystem. |
was based on where the content should be located, not on the content itself.
Since this review, a website team meeting has taken place, as well as a userland migrations meeting, so this issue has been resolved.
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.
Approval for apps/site/pages/en/blog/migrations/v22-to-v24.mdx only (I defer reviewing the rest of this PR to the website team).
|
cc @nodejs/userland-migrations @nodejs/nodejs-website |
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.
It looks like the only changes since I last approved are some dates in metadata?
more thing as been added on |
Signed-off-by: Augustin Mauroy <[email protected]>
apps/site/pages/en/learn/getting-started/userland-migrations.md
Outdated
Show resolved
Hide resolved
|
so sorry @AugustinMauroy and @JakobJingleheimer for the last second review - I know that's a particular pet peeve and I hate to know I am perpetuating it for you. Hope this is simple stuff |
|
@bmuenzenmeyer thansk for the grammar fix |
Co-Authored-By: Brian Muenzenmeyer <[email protected]>
c202fac to
1923ff2
Compare
|
I love these migrations a lot! Question that doesn't seems to be documented yet: How can I run all the migrations with the nodejs scope? Eg. Basically I want to run all the relevant node.js migrations to bring my whole project up to date with a single command. If this is possible. Maybe explain the command as well under the "How to use.." heading?.. |
It's planned to have a codemod like |
Description
Reflect current status of the
userland-migrationinitiative.Add migrations section with article
move userland migration subesection to article
Related Issues
No related issues
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.