Skip to content
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

New area for userland migrations #7267

Open
JakobJingleheimer opened this issue Nov 20, 2024 · 10 comments
Open

New area for userland migrations #7267

JakobJingleheimer opened this issue Nov 20, 2024 · 10 comments
Labels
content Issues/pr concerning content learn Issues/pr concerning the learn section

Comments

@JakobJingleheimer
Copy link
Member

Enter your suggestions in details:

The new userland migrations needs a place on nodejs.org to publicise its existence and explain how to use it. Each API doc may reference a specific migration recipe (probably a link to github), but the overall concept should have its own place. Perhaps a Learn section for authorship and consumption?

@avivkeller avivkeller added content Issues/pr concerning content learn Issues/pr concerning the learn section labels Nov 20, 2024
@ovflowd
Copy link
Member

ovflowd commented Nov 21, 2024

Can you elaborate more?

@AugustinMauroy
Copy link
Member

I'm not 100% sure that good idea to put it in learn but idk where we can put that. Maybe a new subsection on about but not really right

@JakobJingleheimer
Copy link
Member Author

Can you elaborate more?

In what regard? Ex do you want to know what "userland migrations" are, or are you wondering about the content for the new website section?

@bmuenzenmeyer
Copy link
Collaborator

it'd be kinda nice to include within:

perhaps you've given it more thought too @JakobJingleheimer but i am a big +1 to provide this in as many places people will see it

here's some MUI examples

inline within relevant docs

image

upgrade posts

https://mui.com/material-ui/migration/upgrade-to-v6/#breaking-changes

@JakobJingleheimer
Copy link
Member Author

Yes! If the codemod is available when the feature is released (the ideal case), I think it should definitely be included in the release notes / changelog 🙂

@ovflowd
Copy link
Member

ovflowd commented Nov 22, 2024

I believe Brian replied to the questions I had (unintentionally); I wasn't sure what this was about, but having little info boxes across pages mentioning these makes sense to me :)

@JakobJingleheimer
Copy link
Member Author

JakobJingleheimer commented Nov 22, 2024

I believe Brian replied to the questions I had (unintentionally); I wasn't sure what this was about, but having little info boxes across pages mentioning these makes sense to me :)

Including in the changelog is not the request (that has nothing to do with the website team 😜).

Userland Migrations is what I presented in Dublin. See the readme for an explanation of what it is: https://github.com/nodejs/userland-migrations/tree/chore/initial-setup

@mikeesto
Copy link
Member

If I'm understanding correctly - what @JakobJingleheimer is proposing is a new page (or pages) on Learn that explain what codemods are and how to use them. That sounds OK to me.

@AugustinMauroy
Copy link
Member

Yeah @mikeesto I think you got right. But my question is, is the right place ?

@JakobJingleheimer
Copy link
Member Author

Yes, exactly :) Learn was just a starting-point / suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues/pr concerning content learn Issues/pr concerning the learn section
Projects
None yet
Development

No branches or pull requests

6 participants