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

[docs] Add "Migration" section to sidebar and revise v4-v5 content #32740

Merged
merged 51 commits into from
Jun 7, 2022
Merged

[docs] Add "Migration" section to sidebar and revise v4-v5 content #32740

merged 51 commits into from
Jun 7, 2022

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented May 11, 2022

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:

Screen Shot 2022-05-11 at 11 57 38 AM

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:

  • add Migration to sidebar
  • move Migration pages
  • split v4-v5 content
  • revise v4-v5 content
    • Migration
    • Breaking changes - styles and themes
    • Breaking changes - components
    • JSS
    • Troubleshooting
  • find and fix broken links to these pages

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material v5.x migration labels May 11, 2022
@mui-bot
Copy link

mui-bot commented May 11, 2022

No bundle size changes

Generated by 🚫 dangerJS against 3ff10dc

@siriwatknp
Copy link
Member

I am proposing that we add a new section to the Material UI docs sidebar for "Migration" to help draw attention to these docs:

Couldn't agree more 👍

In an effort to make the v4-v5 migration guide more readable, I am going to split the content up into multiple pages. I will also do some copy editing throughout.

Your proposal looks fantastic!

@mapache-salvaje
Copy link
Contributor Author

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 :::success callouts in a later commit.

Screen Shot 2022-05-13 at 5 07 44 PM

I have also opted to split the breaking changes into two separate pages to make them more user-friendly.

Screen Shot 2022-05-13 at 5 11 07 PM

This is turning into a much bigger project than I anticipated. 😅 There is so much content here!

@mapache-salvaje mapache-salvaje requested a review from mnajdova May 31, 2022 16:02
Copy link
Contributor

@danilo-leal danilo-leal left a 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 👏

Copy link
Member

@oliviertassinari oliviertassinari left a 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:

  1. Are we sure about the side nav order? Intuitively, I would imagine Migration to be at the bottom:

Screenshot 2022-06-01 at 19 45 12

  1. I have fixed some of the wrong git diff layouts, but there are more, I gave up 😁.
  2. 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 🙃

@mnajdova
Copy link
Member

mnajdova commented Jun 2, 2022

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 🙃

@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>
@mapache-salvaje
Copy link
Contributor Author

  1. Are we sure about the side nav order? Intuitively, I would imagine Migration to be at the bottom:

I don't have any strong feelings about the order, so I'm cool with moving it to the bottom. 👍

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 5, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 7, 2022
Copy link
Member

@mnajdova mnajdova left a 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!

@mapache-salvaje mapache-salvaje merged commit ba88c00 into mui:master Jun 7, 2022
@mapache-salvaje mapache-salvaje deleted the update-migration branch April 3, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: material-ui Specific to @mui/material v5.x migration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants