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] Document the migration from v3 to v4 #14741

Merged
merged 14 commits into from
Mar 5, 2019

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Mar 4, 2019

Once the next version is advanced enough, we should be able to link (add a banner) from material-ui.com to next.material-ui.com.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Mar 4, 2019
@mui-pr-bot
Copy link

mui-pr-bot commented Mar 4, 2019

Details of bundle changes.

Comparing: a574657...9c13760

bundle parsed diff gzip diff prev parsed current parsed prev gzip current gzip
@material-ui/core 0.00% 0.00% 371,763 371,763 91,901 91,901
@material-ui/core/Paper 0.00% 0.00% 76,649 76,649 19,301 19,301
@material-ui/core/Paper.esm 0.00% 0.00% 71,599 71,599 18,782 18,782
@material-ui/core/Popper 0.00% 0.00% 30,462 30,462 10,583 10,583
@material-ui/core/styles/createMuiTheme 0.00% 0.00% 17,286 17,286 5,717 5,717
@material-ui/core/useMediaQuery 0.00% 0.00% 2,486 2,486 1,047 1,047
@material-ui/lab 0.00% 0.00% 184,282 184,282 50,606 50,606
@material-ui/styles 0.00% 0.00% 57,443 57,443 16,176 16,176
@material-ui/system 0.00% 0.00% 17,062 17,062 4,485 4,485
Button 0.00% 0.00% 99,409 99,409 26,604 26,604
Modal 0.00% 0.00% 98,711 98,711 26,183 26,183
colorManipulator 0.00% 0.00% 3,232 3,232 1,296 1,296
docs.landing +0.09% 🔺 +0.20% 🔺 51,773 51,819 11,244 11,267
docs.main 0.00% -0.00% 678,764 678,772 206,223 206,222
packages/material-ui/build/umd/material-ui.production.min.js 0.00% 0.00% 322,447 322,447 85,066 85,066

Generated by 🚫 dangerJS against 9c13760

- `maxWidthLg`
- `maxWidthXl`

Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section
Have a look at the [overriding with classes](/customization/overrides/#overriding-with-classes) section

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe remove 'section' at the end so the sentence reads:

Have a look at overriding with classes and the implementation of the component for more detail.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is automatically generated, can we handle it in a different pull request? cc @mbrookes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both work, so I guess shorter is better?

Co-Authored-By: oliviertassinari <[email protected]>
Co-Authored-By: oliviertassinari <[email protected]>
@eps1lon
Copy link
Member

eps1lon commented Mar 5, 2019

Once the next version is advanced enough, we should be able to link from material-ui.com to next.material-ui.com.

You mean an automatic redirect?

Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer prop over property in react related docs. Not sure if this is common.

@mbrookes might want to go over the text as a native speaker.

- body1 (default) => body2 (default)
- Remove the opinionated `display: block` default typograpghy style.
You can use the new `display?: 'initial' | 'inline' | 'block';` property.
- Rename the `headlineMapping` property to better align with its purpose.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Rename the `headlineMapping` property to better align with its purpose.
- Rename the `headlineMapping` prop to `variantMapping` to better align with its purpose.

property -> prop depends on whether we use this consistently. I prefer to use the term prop since it's specific to react. In vanilla javascript a property of a class/function would mean something different.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

property vs prop needs to be handled at a global level. I believe we are using property everywhere but I don't mind changing it to better match the reactjs.org wordings. cc @mbrookes. (I'm leaving it as is, we can handle it in a different pull request)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have looked at reactjs.org in more detail. I believe they always use prop/props in the React element context. I'm embarrassed.

@oliviertassinari
Copy link
Member Author

@eps1lon I'm sorry for the confusion, I was thinking of a banner to link between master and next. So people can easily move between the versions.

@oliviertassinari oliviertassinari merged commit 9c7ff49 into mui:next Mar 5, 2019
@oliviertassinari oliviertassinari deleted the docs-migration-guide branch March 5, 2019 18:00
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Mar 5, 2019

This pull request has generated two interested leads for continuation:

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.

6 participants