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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] main menu component names - use singular; use alias for select #17644

Closed
croraf opened this issue Sep 30, 2019 · 4 comments 路 Fixed by #18629
Closed

[docs] main menu component names - use singular; use alias for select #17644

croraf opened this issue Sep 30, 2019 · 4 comments 路 Fixed by #18629
Assignees
Labels
docs Improvements or additions to the documentation
Milestone

Comments

@croraf
Copy link
Contributor

croraf commented Sep 30, 2019

Summary 馃挕

https://github.com/mui-org/material-ui/blob/master/docs/src/pages.js#L19-L123 uses sometimes singular sometimes plural for the name of items:

Selects vs Progress for example. Use singular name everywhere.

Also add Dropdown alias for Select item. Like "Select (Dropdown)" or "Select / Dropdown"
image

Examples 馃寛

Motivation 馃敠

@joshwooding joshwooding added docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. labels Sep 30, 2019
@espipj
Copy link
Contributor

espipj commented Oct 1, 2019

Hello
Can I work on this issue please?
馃槃

@joshwooding
Copy link
Member

@espipj Sure let's see how the @mui-org/core-contributors feel first since this affects naming things.

@croraf
Copy link
Contributor Author

croraf commented Oct 1, 2019

It can perhaps affect current search engine cached results? But in general probably more people search "material ui select" than "material ui selectS"

@croraf croraf changed the title [docs] main menu component names - use singular, alias for select [docs] main menu component names - use singular; use alias for select Oct 1, 2019
@oliviertassinari
Copy link
Member

oliviertassinari commented Oct 1, 2019

uses sometimes singular sometimes plural for the name of items:

I remember we had a discussion about this problem with @mbrookes a few months ago. But I don't remember the outcome. I think that we left it aside as not very important. A benchmark of the side menu:

  • Bootstrap: mixes both
  • Vuetify: mixes both
  • Blueprint: component export name, only
  • Fabric: component export name, a few plurals outside
  • Atlaskit: component export name, only
  • Antd: component export name, only
  • BaseWeb: component export name, only
  • Semantic: component export name, only

I think that I would be in favor of matching the component name export in the side menu and in the page header 1. Regarding the SEO title, they already all match the export name (hence singular most of the time), so it would further increase consistency. My only concern is with the invalidation of the translations 馃. Actually, it's what we have done with all the new components in the lab.

Also add Dropdown alias for Select item. Like "Select (Dropdown)" or "Select / Dropdown"

Do we support dropdown right now?

It can perhaps affect current search engine cached results?

I would be against changing the URLs.

@oliviertassinari oliviertassinari added the hacktoberfest https://hacktoberfest.digitalocean.com/ label Oct 19, 2019
@joshwooding joshwooding removed the hacktoberfest https://hacktoberfest.digitalocean.com/ label Nov 3, 2019
@oliviertassinari oliviertassinari removed the good first issue Great for first contributions. Enable to learn the contribution process. label Nov 30, 2019
@oliviertassinari oliviertassinari self-assigned this Nov 30, 2019
@oliviertassinari oliviertassinari added this to the v5 milestone Nov 30, 2019
oliviertassinari added a commit to oliviertassinari/material-ui that referenced this issue Nov 30, 2019
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 a pull request may close this issue.

4 participants