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] Start enforcing consistency in documentation vocabulary (#6871)Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> #6871

Merged
merged 17 commits into from
Mar 2, 2023
Merged

[docs] Start enforcing consistency in documentation vocabulary (#6871)Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> #6871

merged 17 commits into from
Mar 2, 2023

Conversation

alexfauquette
Copy link
Member

Inspired from #6848

  • enforce API and Typescript

@mui-bot
Copy link

mui-bot commented Nov 16, 2022 •
edited
Loading

Netlify deploy preview

Netlify deploy preview: https://deploy-preview-6871--material-ui-x.netlify.app/

Updated pages

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 621.9 981.8 753.1 774.98 140.335
Sort 100k rows ms 635.2 1,005 894.3 903.7 140.115
Select 100k rows ms 223.8 303 281.3 267.38 34.063
Deselect 100k rows ms 146.6 228.6 170 179.82 30.831

Generated by 🚫 dangerJS against d36cc0e

flaviendelangle
flaviendelangle reviewed Nov 16, 2022
View reviewed changes
Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

Maybe we can black list "Data grid" in favor of "Data Grid"
Same for "Date picker" => "Date Picker", "Time picker" => "Time Picker" etc...

@samuelsycamore

.github/styles/Blog/NamingConventions.yml Outdated
# swap maps tokens in form of bad: good
# for more information: https://vale.sh/docs/topics/styles/#substitution
swap:
'[A|a]pi': API
Copy link
Member

Choose a reason for hiding this comment

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

Maybe just putting two lines here would be easier to read than a pattern

@flaviendelangle
Copy link
Member

@alexfauquette I'd say it's a [docs] PR since it impacts the doc content

@zannager zannager added the core Infrastructure work going on behind the scenes label Nov 16, 2022
@alexfauquette alexfauquette changed the title [core] Start enforcing consistency in documentation vocabulary [docs] Start enforcing consistency in documentation vocabulary Nov 16, 2022
m4theushw
m4theushw reviewed Nov 16, 2022
View reviewed changes
Copy link
Member

@m4theushw m4theushw left a comment

Choose a reason for hiding this comment

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

We use a lot "the grid", which I think should be "the data grid". Can we have a rule for it if everybody aggress? @samuelsycamore proposed some conventions in https://mui-org.slack.com/archives/C02EAR1R8CC/p1663942713390919

/cc @mui/xgrid

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Nov 16, 2022 •
edited
Loading

"TypeScript" should be capitalized the same as "JavaScript" - that's how it's formatted in the official docs.

As for the Data Grid conventions, I think that anytime you're referring to the MUI X product, or an instance of it, it should be capitalized. It might be redundant/unnecessary to specify "Data Grid" every time, so I think it's fine to shorten it to "Grid," but I would still capitalize it to make it clear that you're referring to the MUI product. The only time I would use "data grid" (lowercase) is when referring to the concept of such a thing, i.e. "The MUI X Data Grid is a type of data grid."

Edit: here's the doc I created that provides some more details—Style conventions for MUI components and products.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Nov 22, 2022
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Dec 23, 2022
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

samuelsycamore
samuelsycamore reviewed Dec 27, 2022
View reviewed changes
.github/styles/Blog/ComponentNaming.yml Outdated Show resolved Hide resolved
.github/styles/Blog/ComposedWords.yml Outdated Show resolved Hide resolved
.github/styles/Blog/NamingConventions.yml Outdated Show resolved Hide resolved
alexfauquette and others added 3 commits January 26, 2023 16:02
@alexfauquette
Merge remote-tracking branch 'upstream/next' into vale-typo
47d35df
@alexfauquette
fixes
080c3e8
@alexfauquette @samuelsycamore
Apply suggestions from code review
9ab08fd 
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 26, 2023
@alexfauquette
Copy link
Member Author

@samuelsycamore If you're okay with the modifications in this PR, we can merge it :)

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 18, 2023
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

samuelsycamore
samuelsycamore reviewed Feb 21, 2023
View reviewed changes
.github/styles/Blog/ComponentNaming.yml Outdated
time range picker: Time Range Picker
date time range picker: Date Time Range Picker
# use data grid instead of grid
the grid: the data grid
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
the grid: the data grid
the grid: the Data Grid

.github/styles/Blog/ComponentNaming.yml Outdated
date range picker: Date Range Picker
time range picker: Time Range Picker
date time range picker: Date Time Range Picker
# use data grid instead of grid
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# use data grid instead of grid
# use Data Grid instead of grid

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 2, 2023
@alexfauquette alexfauquette changed the title [docs] Start enforcing consistency in documentation vocabulary [docs] Start enforcing consistency in documentation vocabulary (#6871)Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Mar 2, 2023
@alexfauquette alexfauquette merged commit 107a198 into mui:next Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samuelsycamore samuelsycamore samuelsycamore left review comments

@m4theushw m4theushw m4theushw left review comments

@flaviendelangle flaviendelangle flaviendelangle left review comments

Assignees
No one assigned
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@alexfauquette @mui-bot @flaviendelangle @samuelsycamore @m4theushw @zannager