-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
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
[docs] Add "Migration" section to sidebar and revise v4-v5 content #32740
Conversation
Couldn't agree more 👍
Your proposal looks fantastic! |
I have added ✅ emoji next to all of the breaking changes that are handled by codemods. I think this makes it much easier to navigate through these docs, and to use the right side nav bar to quickly skim through the content. I will most likely remove the redundant I have also opted to split the breaking changes into two separate pages to make them more user-friendly. This is turning into a much bigger project than I anticipated. 😅 There is so much content here! |
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.
Woof, this is so good! Fantastic work, Sam 👏
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's so much better with the reorganization 🔥😍, great execution!
Things that I have noticed:
- Are we sure about the side nav order? Intuitively, I would imagine Migration to be at the bottom:
- I have fixed some of the wrong git diff layouts, but there are more, I gave up 😁.
- I wonder if we didn't go too much into the details of the breaking changes, it's overwhelming. We never went as much in the details in the past. If it's not about the level of details, then it's about the number. We would likely want to enforce a maximum limit on the number of breaking changes per release. v4 -> v5 might be a good reference to what should be the absolute maximum cc @mnajdova oops 🙃
docs/data/material/migration/migration-v4/v5-component-changes.md
Outdated
Show resolved
Hide resolved
docs/data/material/migration/migration-v4/v5-component-changes.md
Outdated
Show resolved
Hide resolved
docs/data/material/migration/migration-v4/v5-component-changes.md
Outdated
Show resolved
Hide resolved
docs/data/material/migration/migration-v4/migrating-from-jss.md
Outdated
Show resolved
Hide resolved
@oliviertassinari I would say we should never do that many breaking changes ever again (not to consider this absolute maximum :)) I almost think it would have been best if we did two major releases in a year (one focusing only on the styling solution changes and another one on the API changes/bug fixes). But anyway, it is late for that kind of discussion now. |
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
I don't have any strong feelings about the order, so I'm cool with moving it to the bottom. 👍 |
docs/data/material/migration/migration-v4/migrating-from-jss.md
Outdated
Show resolved
Hide 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.
Looks awesome! Great execution Sam!
https://deploy-preview-32740--material-ui.netlify.app/material-ui/migration/migration-v4/
https://deploy-preview-32740--material-ui.netlify.app/material-ui/migration/v5-style-changes/
https://deploy-preview-32740--material-ui.netlify.app/material-ui/migration/v5-component-changes/
https://deploy-preview-32740--material-ui.netlify.app/material-ui/migration/migrating-from-jss/
https://deploy-preview-32740--material-ui.netlify.app/material-ui/migration/troubleshooting/
This PR addresses the ongoing need to get more developers to migrate to Material UI v5.
I am proposing that we add a new section to the Material UI docs sidebar for "Migration" to help draw attention to these docs:
In an effort to make the v4-v5 migration guide more readable, I have split the content up into multiple pages. I have also done some copy editing throughout.
I have attempted to make it more clear that you do not need to migrate away from JSS to start using v5, as well as the fact that you need to move to v5 for React 18.
I don't intend to make any changes to the earlier migration guides, other than to move them to this new section.
To do: