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] Make migration doc easier to follow #26948

Merged
merged 40 commits into from Jul 15, 2021

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp commented Jun 25, 2021

Preview: https://deploy-preview-26948--material-ui.netlify.app/guides/migration-v4/.

https://github.com/siriwatknp/material-ui/blob/fix%2Fmigration-docs/docs/src/pages/guides/migration-v4/migration-v4.md

The goal of this change is to make migration doc easier to go through from top to bottom.

Here is the summary of the steps I proposed in the change

  • Update React & TypeScript

  • ThemeProvider Setup

  • Update Material-UI

  • Run Codemod

  • Handling Breaking Changes

  • Migrate makeStyles to emotion

  • Troubleshooting

  • I have followed (at least) the PR section of the contributing guide.

@siriwatknp siriwatknp added the docs Improvements or additions to the documentation label Jun 25, 2021
@mui-pr-bot
Copy link

mui-pr-bot commented Jun 25, 2021

No bundle size changes (experimental)

Generated by 🚫 dangerJS against 6bee13b

@siriwatknp siriwatknp changed the title [docs] Update migration doc as steps [docs] Make migration doc easier to follow Jun 25, 2021
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Co-authored-by: Matt <github@nospam.33m.co>
@siriwatknp siriwatknp marked this pull request as ready for review June 28, 2021 04:47
@siriwatknp siriwatknp marked this pull request as draft June 28, 2021 04:47
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 13, 2021
@siriwatknp siriwatknp marked this pull request as ready for review July 13, 2021 08:37
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 13, 2021
@mnajdova
Copy link
Member

mnajdova commented Jul 13, 2021

I wonder whether it will be easier if we list first the changes not supported by the codemod, and then the rest of them. For developers that would use the codemod, I don't think that they need to go through all changes already handled by the codemod, in order to decide which ones are not handled.

@siriwatknp
Copy link
Member Author

siriwatknp commented Jul 13, 2021

I wonder whether it will be easier if we list first the changes not supported by the codemod, and then the rest of them. For developers that would use the codemod, I don't think that they need to go through all changes already handled by the codemod, in order to decide which ones are not handled.

Are you suggested to move the breaking changes that already handled by codemod into another section?

I thought about it too but I don't want to change things too much and I am still doubt if it is actually better than the current one.

@mnajdova
Copy link
Member

Are you suggested to move the breaking changes that already handled by codemod into another section?

I am not sure either, reading trough it, I felt like I could have skipped lot of the content as it was already handled by the codemod…

@mnajdova mnajdova closed this Jul 13, 2021
@mnajdova mnajdova reopened this Jul 13, 2021
@mnajdova
Copy link
Member

Sorry for closing it 😅 wrong click :)

docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
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.

Looks great, I had a quick scan, can't notice anything specifically wrong. If you see a horizontal scrollbar issue like me on the live preview, you can rebase on HEAD, we fixed it.

docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved
siriwatknp and others added 4 commits July 15, 2021 13:57
@siriwatknp siriwatknp merged commit ca974a5 into mui:next Jul 15, 2021
@siriwatknp siriwatknp deleted the fix/migration-docs branch July 15, 2021 09:59
@thorn0
Copy link

thorn0 commented Aug 6, 2021

Sorry, didn't read through all the comments. Why is it necessary to upgrade react-scripts? Will something not work if I keep react-scripts 3.4.1?

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 v5.x migration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants