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] Improve Support page #11556

Merged
merged 5 commits into from
Jan 28, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jan 2, 2024

My idea is to create a standard for the Support page, starting with MUI X.

To then go to the core and update Material UI support, create Base UI, MUI System support pages, etc. I'm not a fan of https://mui.com/material-ui/getting-started/support/.

Preview: https://deploy-preview-11556--material-ui-x.netlify.app/x/introduction/support/

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 2, 2024
@mui-bot
Copy link

mui-bot commented Jan 2, 2024

Deploy preview: https://deploy-preview-11556--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against 2c87975

Comment on lines -91 to -94
### GitHub

We use GitHub issues as a bug and feature request tracker.
If you think you've found a bug, or you have a new feature idea, please start by [making sure it hasn't already been reported or fixed](https://github.com/mui/mui-x/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed).
Copy link
Member Author

Choose a reason for hiding this comment

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

Remove all of that, I don't see the value of it, it looks best to link to the docs, to have 1. no duplication 2. something always up to date, even on older npm packages releases.

Comment on lines 61 to 67

## Community

We have a [Discord Server](https://mui.com/r/discord/) to allow the MUI X community to gather.
Our tools are used by thousands of developers and teams all around the world, many of whom actively engage with the community.

You can join Discord to engage in lively discussions, share your projects, and interact with developers just like you from all around the world. We'd love for you to be a part of our community!
Copy link
Member Author

Choose a reason for hiding this comment

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

It feels like we can still link to Discord, but further buried and with a clear purpose statement.

Comment on lines -37 to +46
### Long-term support (LTS)
## Long-term support (LTS)
Copy link
Member Author

Choose a reason for hiding this comment

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

Looks like a mistake

Comment on lines 39 to 48
Bug fixes, performance enhancements, and other improvements are delivered in new releases. However, MUI remains committed to providing security updates and addressing regressions for the immediate predecessor of the current major version.
Bug fixes, performance enhancements, and other improvements are delivered in new releases. However, we remain committed to providing security updates and addressing regressions for the immediate predecessor of the current major version.
Copy link
Member Author

@oliviertassinari oliviertassinari Jan 2, 2024

Choose a reason for hiding this comment

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

I try to fade the company name (MUI) from the docs. My idea is that we probably don't want to have it referenced, to reach a point where it's almost not visible anywhere.

Go to https://react.dev/, you won't find the docs using "Meta", it uses "We" or "React team". Same observation on https://nextjs.org/. The value I see is that:

  • Keep the audience focused on learning MUI X
  • As MUI grows, it feels weird to reference an organization that is bigger than the project, as a reader of the docs, I would want to hear the team's voice directly.

cc @danilo-leal this would likely further help with the confusion. For example in https://mui.com/material-ui/getting-started/support/#github:

Screenshot 2024-01-02 at 23 13 33

The immediate conclusion I make is that MUI is the name of the open-source project.

Comment on lines 25 to 34
When purchasing a MUI X Pro or Premium license you get access to technical support until the end of your subscription.
When purchasing a MUI X Pro or Premium license you get access to technical support until the end of your active license.
Copy link
Member Author

Choose a reason for hiding this comment

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

A change we are making with @rluzists1 we are taking steps to define this "active license" notion https://github.com/mui/mui-private/pull/332. Avoiding "subscription" as it has a bad-rep.


[Post a question about MUI X](https://stackoverflow.com/questions/tagged/mui-x) on Stack Overflow using the "mui-x" tag.
If you can't find your answer, [ask a new question](https://stackoverflow.com/questions/ask?tags=reactjs%20mui-x) using the relevant tags.
Copy link
Member Author

Choose a reason for hiding this comment

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

I too often see developers opening questions with the wrong tag.

docs/data/introduction/support/support.md Outdated Show resolved Hide resolved
docs/data/introduction/support/support.md Outdated Show resolved Hide resolved
docs/data/introduction/support/support.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 20, 2024
Copy link

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

oliviertassinari and others added 2 commits January 28, 2024 19:23
Co-authored-by: Sam Sycamore <[email protected]>
Signed-off-by: Olivier Tassinari <[email protected]>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 28, 2024
oliviertassinari and others added 2 commits January 28, 2024 19:26
Co-authored-by: Sam Sycamore <[email protected]>
Signed-off-by: Olivier Tassinari <[email protected]>
@oliviertassinari oliviertassinari force-pushed the stack-overflow-labels branch 2 times, most recently from 26549c1 to 1b68f56 Compare January 28, 2024 18:52
@oliviertassinari oliviertassinari merged commit 1bacf39 into mui:next Jan 28, 2024
13 of 15 checks passed
@oliviertassinari oliviertassinari deleted the stack-overflow-labels branch January 28, 2024 19:06
oliviertassinari added a commit that referenced this pull request Jan 28, 2024
Signed-off-by: Olivier Tassinari <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]>
oliviertassinari added a commit to mui/material-ui that referenced this pull request Jan 28, 2024
mostafa-rio pushed a commit to mostafa-rio/material-ui that referenced this pull request Feb 3, 2024
thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
Signed-off-by: Olivier Tassinari <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]>
adonislucky pushed a commit to adonislucky/base-ui that referenced this pull request Sep 16, 2024
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 this pull request may close these issues.

3 participants