Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[docs-infra] Enforce brand name rules #40525

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
Merged
merged 4 commits into from
Jan 16, 2024
Merged

[docs-infra] Enforce brand name rules #40525

merged 4 commits into from
Jan 16, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jan 11, 2024 •
edited
Loading

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 type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature. scope: docs-infra Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305). labels Jan 11, 2024
@mui-bot
Copy link

mui-bot commented Jan 11, 2024 •
edited
Loading

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

@oliviertassinari oliviertassinari requested review from mapache-salvaje and removed request for alexfauquette January 11, 2024 12:22
alexfauquette
alexfauquette reviewed Jan 11, 2024
View reviewed changes
oliviertassinari and others added 2 commits January 11, 2024 22:41
@oliviertassinari @alexfauquette
Update .github/styles/Blog/BrandName.yml
9409e1f 
Co-authored-by: Alexandre Fauquette <[email protected]>
Signed-off-by: Olivier Tassinari <[email protected]>
@oliviertassinari @alexfauquette
Update .github/styles/Blog/NoCompanyName.yml
24819fe 
Co-authored-by: Alexandre Fauquette <[email protected]>
Signed-off-by: Olivier Tassinari <[email protected]>
@oliviertassinari oliviertassinari mentioned this pull request Jan 11, 2024
Merged
oliviertassinari
oliviertassinari commented Jan 11, 2024
View reviewed changes
@oliviertassinari oliviertassinari merged commit 8cdf913 into mui:master Jan 16, 2024
@oliviertassinari oliviertassinari deleted the brand-name branch January 16, 2024 00:54
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 16, 2024 •
edited
Loading

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

I guess we can enable https://github.com/errata-ai/vale-action?tab=readme-ov-file#fail_on_error-default-false

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jan 20, 2024 •
edited
Loading

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:

This was referenced Jan 20, 2024
Merged
Merged
oliviertassinari added a commit that referenced this pull request Jan 20, 2024
@oliviertassinari
[docs] Improve error message for MUI Vale rule
b6d93cf 
Act on #40525 (comment)
oliviertassinari added a commit to mui/mui-x that referenced this pull request Jan 20, 2024
@oliviertassinari
[docs] Improve error message for MUI Vale rule
95d9158 
Act on mui/material-ui#40525 (comment)
@oliviertassinari oliviertassinari mentioned this pull request Feb 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexfauquette alexfauquette alexfauquette left review comments

@mapache-salvaje mapache-salvaje mapache-salvaje approved these changes

Assignees
No one assigned
Labels
scope: docs-infra Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305). type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@oliviertassinari @mui-bot @alexfauquette @mapache-salvaje