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.

Sign up for GitHub

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

Jump to bottom

[docs] Reword unsupported material components notes #16660

Merged
merged 4 commits into from
Jul 21, 2019
Merged

[docs] Reword unsupported material components notes #16660

merged 4 commits into from
Jul 21, 2019

Conversation

m2mathew
Copy link
Member

@m2mathew m2mathew commented Jul 20, 2019 •
edited by oliviertassinari
Loading

The issue

As mentioned in #16513, some visitors to the docs might read the alerts about "no longer documented" components and think that MUI will stop supporting those components. However, the alert only means to warn users that the Material Design specifcation is no longer supporting the components in question.

The solution

Update the wording to be more clear that MUI will continue to support these components:

  • Steppers
  • Expansion Panel
  • Text Field (without variant)

Visuals

Area Before After
Steppers image image
Expansion Panels image image
Text Field (without variant) image image

To test

  • Get this code.
  • Ensure that you see alerts for the changed areas as expected.

Closes #16513

@m2mathew m2mathew added the docs Improvements or additions to the documentation label Jul 20, 2019
@mui-pr-bot
Copy link

mui-pr-bot commented Jul 20, 2019 •
edited
Loading

No bundle size changes comparing 95cbe4f...d4318aa

Generated by 🚫 dangerJS against d4318aa

@m2mathew
Copy link
Member Author

@eps1lon Good call. PR updated along with updated screenshots in the Description above.

joshwooding
joshwooding previously requested changes Jul 20, 2019
View reviewed changes
Copy link
Member

@joshwooding joshwooding left a comment

Choose a reason for hiding this comment

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

Nice, You only need to change the English files the rest are handled by CrowdIn.

@oliviertassinari oliviertassinari changed the title [Docs] Reword unsupported material components alert [docs] Reword unsupported material components notes Jul 20, 2019
@m2mathew
Copy link
Member Author

@joshwooding Thanks. I wasn't sure how the translated pages were handled. All updated now.

@oliviertassinari oliviertassinari merged commit a3ae056 into mui:master Jul 21, 2019
@oliviertassinari
Copy link
Member

@m2mathew 👌

@snyk-bot snyk-bot mentioned this pull request Sep 4, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eps1lon eps1lon eps1lon left review comments

@joshwooding joshwooding joshwooding approved these changes

@oliviertassinari oliviertassinari oliviertassinari approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

What the meaning of Note: [This component] are no longer documented in the Material Design documentation.
5 participants
@m2mathew @mui-pr-bot @oliviertassinari @eps1lon @joshwooding