[docs] Create an "Advanced Components" home page #4298
Conversation
|
These are the results for the performance tests:
|
flaviendelangle
added
component: data grid
|
|
||
| For each set of component, you can check the feature comparison table: | ||
|
|
||
| - [Data Grid](/x/react-data-grid/getting-started/#feature-comparison) |
There was a problem hiding this comment.
Should we directly link to the pricing page which has the most advanced feature comparison UI ?
Right now we have 3 lists:
- https://mui.com/pricing/
- https://mui.com/components/data-grid/getting-started/#feature-comparison
- https://mui.com/components/data-grid/#features
I would at least drop the 3rd one (not in this PR)
There was a problem hiding this comment.
I do not know if we should remove mui.com/components/data-grid/#features
For sure we should not link to this section because it is less informative than feature comparison. But it seems to be a good way to give an overview of what is available in the component without having to navigate on a big table
There was a problem hiding this comment.
I find it not very usable
You have a flat mix of
- advanced features (Row Grouping, Column Pinning, etc...)
- very basic things that we obviously support (Pagination)
- marketing statements with no real meaning (High performance, 100% customizable)
If the goal is to give an insight of the pover of the grid, the I think the list could be two times shorter with only the most interesting ones.
There was a problem hiding this comment.
The capitalization convention we use from what I understand
| - [Data Grid](/x/react-data-grid/getting-started/#feature-comparison) | |
| - [Data grid](/x/react-data-grid/getting-started/#feature-comparison) |
There was a problem hiding this comment.
I think the mui.com/pricing page is the best place to send people.
There was a problem hiding this comment.
@oliviertassinari I believe it should be capitalized since it's referring to The MUI X Data Grid, as opposed to any generic data grid or the concept in general.
There was a problem hiding this comment.
I think the mui.com/pricing page is the best place to send people.
@samuelsycamore would you keep https://mui.com/components/data-grid/getting-started/#feature-comparison
And if so, for which usages ?
There was a problem hiding this comment.
@flaviendelangle is there any info on that page that isn't included on the Pricing page? If it's all there already then I think this #feature-comparison section is redundant. I would lean toward keeping all of this info on the Pricing page as the single source of truth.
There was a problem hiding this comment.
- https://mui.com/pricing/
- https://mui.com/components/data-grid/getting-started/#feature-comparison
- https://mui.com/components/data-grid/#features
The 1st two are almost identical (but the 2nd is DataGrid only)
Le 3rd one is a partial list
I think we could have two at most
With :
- The pricing page with a very detailed collapsible list, that serve as source of truth for our community
- On section in each component page focusing only on the most important / most exciting features of the pro / premium, to serve as an entry point for Community users to give them a taste of what we have and give them a reason to go to the full list
|
|
||
| <p class="description">A collection of fast and powerful components.</p> | ||
|
|
||
| ## Licenses |
There was a problem hiding this comment.
This section is inspired by Data Grid - Getting Started # Plans but reworked
| The features exclusives to the **Premium** Plan are marked with the <span class="plan-premium"></span> icon across our documentation. | ||
| The **Premium** Plan also contains all the features of the **Pro** Plan | ||
|
|
||
| ## MIT vs. commercial |
There was a problem hiding this comment.
Is this section really necessary? I don't think we need to keep trying to justify the existence of our paid products. It makes us look oddly defensive, especially to devote so many words to it. If it needs to stay, I think a few sentences would be plenty.
There was a problem hiding this comment.
Copy / pasted
But I agree that we talk a lot about the "why", which was maybe useful one year ago, but now our product feature should justify the cost by themselves.
| @@ -25,7 +25,7 @@ jobs: | |||
| We use GitHub issues as a bug and feature requests tracker, however, | |||
| this issue appears to be a support request. | |||
|
|
|||
| For support, please check out https://mui.com/components/data-grid/getting-started/#support. Thanks! | |||
| For support, please check out https://mui.com/getting-started/support/. Thanks! | |||
There was a problem hiding this comment.
To be consistent with the issue templates I put the link of the core doc
I don't know if we should strengthen our Support section (or do an Advanced Components - Support page) and use it on the Issue templates AND on the Stackoverflow bot.
flaviendelangle
changed the title
flaviendelangle
requested review from
joserodolfofreitas,
samuelsycamore and
alexfauquette
flaviendelangle
changed the title
|
|
||
| For each set of component, you can check the feature comparison table: | ||
|
|
||
| - [Data Grid](/x/react-data-grid/getting-started/#feature-comparison) |
There was a problem hiding this comment.
I do not know if we should remove mui.com/components/data-grid/#features
For sure we should not link to this section because it is less informative than feature comparison. But it seems to be a good way to give an overview of what is available in the component without having to navigate on a big table
| While MUI Core is entirely licensed under MIT, MUI X serves a part of its components under a commercial license. | ||
| Please pay attention to the license. | ||
|
|
||
| ### Community Plan |
There was a problem hiding this comment.
https://www.notion.so/mui-org/Style-guide-2a957a4168a54d47b14bae026d06a24b#d8e9cfb2423c4f83844a9f29d2032e3f and for the other? Not sure
| ### Community Plan | |
| ### Community plan |
There was a problem hiding this comment.
If it's a proper noun that's normally capitalized as "Community Plan" when used in a sentence, then it's correct as is.
There was a problem hiding this comment.
I am in favor of using "Pro Plan" / "Community Plan" / "Premium Plan"
|
|
||
| For each set of component, you can check the feature comparison table: | ||
|
|
||
| - [Data Grid](/x/react-data-grid/getting-started/#feature-comparison) |
There was a problem hiding this comment.
The capitalization convention we use from what I understand
| - [Data Grid](/x/react-data-grid/getting-started/#feature-comparison) | |
| - [Data grid](/x/react-data-grid/getting-started/#feature-comparison) |
|
Once this change gets live, we will need to update links, for instance, https://github.com/mui/mui-store/blob/6e2253ff880d5ccf25723a22e78286b56963aeaf/lambda/keymailer/index.js#L8 won't work anymore. |
| While MUI Core is entirely licensed under MIT, MUI X serves a part of its components under a commercial license. | ||
| Please pay attention to the license. | ||
|
|
||
| ### Community Plan |
There was a problem hiding this comment.
If it's a proper noun that's normally capitalized as "Community Plan" when used in a sentence, then it's correct as is.
| ### Professional support | ||
|
|
||
| When purchasing an MUI X Pro or Premium license you get access to professional support for a limited duration. | ||
| Support is available on multiple channels, but the recommended channel is GitHub issues. |
There was a problem hiding this comment.
What are the "multiple channels"? Seems like it's just GitHub and email, so let's say that instead.
| Support is available on multiple channels, but the recommended channel is GitHub issues. | |
| We recommend that you use [GitHub Issues](https://github.com/mui/mui-x/issues/) for support requests. |
There was a problem hiding this comment.
You also have Zendesk, I don't know how people access this one
@DanailH ?
| Support is available on multiple channels, but the recommended channel is GitHub issues. | ||
| If you need to share private information, you can also use email. | ||
|
|
||
| - **MUI X Pro**: No SLA is provided but MUI's maintainers give these issues more attention than the ones from the Community plan. The channels: |
There was a problem hiding this comment.
What does SLA mean in this context? Is there another way to say this?
| - **MUI X Pro**: No SLA is provided but MUI's maintainers give these issues more attention than the ones from the Community plan. The channels: | |
| - **MUI X Pro**: No SLA is provided but MUI's maintainers give these issues more attention than the ones from the Community plan. The channels: |
There was a problem hiding this comment.
| - **MUI X Premium**: Same as MUI X Pro, but with priority over Pro, and a 48 hour SLA for the first answer. | ||
| - GitHub: this plan is not available yet | ||
| - Emails: this plan is not available yet | ||
| - **MUI X Premium Priority**: Same as MUI X Premium but with a 24 hours SLA for the first answer. | ||
| - GitHub: this plan is not available yet | ||
| - Emails: this plan is not available yet |
There was a problem hiding this comment.
Is this necessary since these plans are not yet available?
There was a problem hiding this comment.
Copy / Pasted, so no strong feeling here
@oliviertassinari
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
flaviendelangle
requested review from
samuelsycamore,
oliviertassinari and
alexfauquette
⚠ This page will only be available on the new doc architecture that will be published on the same release as the date pickers migration.
The Premium Plan being released after, the content of these pages will have to be adapted next week.
Doc preview
Now that we have two sets of components (Data Grid and Date Pickers), all the content that is not limited to the Data Grid should be available outside of the Data Grid documentation.
Move thje "Licenses" / "License key" / "Support" and "Roadmap" sections from Data Grid - Getting Started to Advanced Components - Overview
Add a small "Licenses" section on Data Grid - Getting Started to backlink to Advanced Components - Overview
Maybe we need to keep other sections, I don't like to duplicate content but users should not miss the important content.
Rework the plans description.
For this part there are probably improvements to be done.
Links to update in the core
https://github.com/mui/material-ui/blob/master/docs/src/components/pricing/FAQ.tsx#L76
What's next ?