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-infra] Enforce brand name rules #40525

Merged
merged 4 commits into from
Jan 16, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jan 11, 2024

This is a continuation of mui/mui-x#11645 (comment). See how annoying it is when a non-breaking space is missed with MUI X. That line breaks in the middle 🙈. The other objective is to flag all the cases where we use MUI. In 80% of the time, this shouldn't happen in the first place.

This seems to work:

Screen.Recording.2024-01-16.at.01.52.26.mov

@oliviertassinari oliviertassinari added enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product labels Jan 11, 2024
@mui-bot
Copy link

mui-bot commented Jan 11, 2024

Netlify deploy preview

https://deploy-preview-40525--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 7b7a56a

.github/styles/Blog/NoCompanyName.yml Outdated Show resolved Hide resolved
.github/styles/Blog/BrandName.yml Outdated Show resolved Hide resolved
oliviertassinari and others added 2 commits January 11, 2024 22:41
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
@oliviertassinari oliviertassinari merged commit 8cdf913 into mui:master Jan 16, 2024
22 checks passed
@oliviertassinari oliviertassinari deleted the brand-name branch January 16, 2024 00:54
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 16, 2024

Next, I think we should:

  • Rename MUI X, MUI System, name in the whole codebase
  • Enforce MUI X, MUI System name consistency to fail in the CI (Vale is only a hint right now). Maybe an eslint rule or markdownlint rule, or run Vale error mode.
  • Fix the MUI instance

@alexfauquette
Copy link
Member

Enforce MUI X, MUI System name consistency to fail in the CI (Vale is only a hint right now). Maybe an eslint rule or markdownlint rule, or run Vale error mode.

I don't know how it react with the setting level: error if it fails the PR or not. BY the ways vale is here for transitioning. It only verifies lines that are modified in the PR

If installed I tend to disable all other rules, and then run the next command to verify if I missed some fixed

vale ./docs/data/**/*.md > t.txt

@oliviertassinari
Copy link
Member Author

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 20, 2024

I don't know how it react with the setting level: error if it fails the PR or not. BY the ways vale is here for transitioning. It only verifies lines that are modified in the PR

@alexfauquette It fails the CI, perfect.


We forgot MUI Core, MUI Store, MUI Toolpad, MUI Connect, adding to the list:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants