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 to DataGrid v6 page #6235

Merged
merged 9 commits into from
Oct 10, 2022
Merged

Conversation

m4theushw
Copy link
Member

@m4theushw m4theushw commented Sep 21, 2022

@m4theushw m4theushw added the docs Improvements or additions to the documentation label Sep 21, 2022
@mui-bot
Copy link

mui-bot commented Sep 21, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 603.3 1,055.8 675.7 815.46 168.639
Sort 100k rows ms 666.5 1,302.8 1,302.8 1,013.96 224.619
Select 100k rows ms 219.4 295.5 255.7 252.72 29.383
Deselect 100k rows ms 144.5 252.5 209.3 204.26 34.663

Generated by 🚫 dangerJS against ff9c287

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented Sep 22, 2022

As I understand, the data grid and date pickers will have each their own migration guide.

I think we could also* have an "MUI X migration page" combining both MD files, to be referenced in tweets, blogs and other announcements. A "landing page" for migration. Does that make sense to you?
Maybe we could add it to the "Introduction" section.

cc/ @flaviendelangle

@flaviendelangle
Copy link
Member

I guess we have two options

  1. We do like the core with a Migration section in the nav bar with a "home page" (equivalent of this page for the core) plus one page per product line (one for the pickers and one for the grid)

  2. We do one page per product line in their own doc scope and we create a "home page" in the "Introduction" section

I prefer the first option

@joserodolfofreitas
Copy link
Member

Yeah, thanks for pointing that out. I agree a navbar section is a good option, it'll likely get more attention than on introduction, plus we keep consistency with the core.
Let's move forward with that.

@m4theushw
Copy link
Member Author

@joserodolfofreitas What should be the content structure of this homepage for migration? I don't think we have many topics to cover, like https://mui.com/material-ui/migration/migration-v4/, the main purpose are the breaking changes.

Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
Signed-off-by: Matheus Wichman <matheushw@outlook.com>
@joserodolfofreitas
Copy link
Member

@m4theushw, it's fine that there isn't much content on this page. If it covers everything we need to migrate and it's short, it's perfect.
This is going to be a living page that we edit with each PR that adds a breaking change.

m4theushw and others added 3 commits October 10, 2022 10:20
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
Signed-off-by: Matheus Wichman <matheushw@outlook.com>
@m4theushw m4theushw merged commit 2b3d670 into mui:next Oct 10, 2022
@m4theushw m4theushw deleted the migration-guide branch October 10, 2022 13:50
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants