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] Revise and split up "Overview" page into "Introduction" section #4692

Merged
merged 76 commits into from
Jul 7, 2022
Merged

[docs] Revise and split up "Overview" page into "Introduction" section #4692

merged 76 commits into from
Jul 7, 2022

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Apr 28, 2022

Doc preview: https://deploy-preview-4692--material-ui-x.netlify.app/

This PR revises and splits up the content on the Overview page.

Follow up to: Add and/or revise "Overview" pages for each MUI product

The new Introduction section features 5 pages:

  • Overview
  • Installation
  • Licensing
  • Support
  • Roadmap

I rewrote the content on the Overview page to match the formatting of the Base Overview page.

@samuelsycamore samuelsycamore added the docs Improvements or additions to the documentation label Apr 28, 2022
@samuelsycamore samuelsycamore requested a review from a team April 28, 2022 17:39
@mui-bot
Copy link

mui-bot commented Apr 28, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 248.6 509.7 377.9 368.54 102.379
Sort 100k rows ms 558.1 1,083.7 558.1 825.1 199.768
Select 100k rows ms 154.5 283.1 192.9 198.02 45.162
Deselect 100k rows ms 108.5 220.5 170.3 167.76 43.958

Generated by 🚫 dangerJS against 1b259aa

@oliviertassinari

This comment was marked as resolved.

@oliviertassinari

This comment was marked as resolved.

@m4theushw m4theushw self-requested a review May 2, 2022 20:16
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.

I'm not sure why, but the doc switcher widget at the top of the nav bar isn't showing up on the new pages I created. Maybe someone can help me figure out how to make it come back? 😅

I think you have old dependencies. Try switching to master and run git pull, then go back to this branch, run git merge master and commit.

docs/data/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/pages.ts Outdated Show resolved Hide resolved
@cherniavskii
Copy link
Member

Try switching to master and run git pull, then go back to this branch, run git merge master and commit.

@m4theushw @samuelsycamore I would wait with this until mui/material-ui#32552 is merged, otherwise docs:dev won't work

@cherniavskii
Copy link
Member

@samuelsycamore

I'm not sure why, but the doc switcher widget at the top of the nav bar isn't showing up on the new pages I created. Maybe someone can help me figure out how to make it come back?

Ok, it needs a change in the core repo right here:
https://github.com/mui/material-ui/blob/f4818344868ffeaff31e613be90edaf82d3c801e/docs/src/modules/components/AppNavDrawer.js#L656

diff --git a/docs/src/modules/components/AppNavDrawer.js b/docs/src/modules/components/AppNavDrawer.js
index 2e5f8225f05..07c1b4fec9f 100644
--- a/docs/src/modules/components/AppNavDrawer.js
+++ b/docs/src/modules/components/AppNavDrawer.js
@@ -653,7 +653,7 @@ export default function AppNavDrawer(props) {
               ])}
             />
           )}
-          {asPathWithoutLang.startsWith('/x/advanced-components') && (
+          {asPathWithoutLang.startsWith('/x/getting-started') && (
             <ProductIdentifier name="Advanced components" metadata="MUI X" />
           )}

I can open a PR addressing this or feel free to open one if you want :)
After merging it, @mui/monorepo commit should be updated in this PR:

mui-x/yarn.lock

Lines 2602 to 2604 in cfc9a6f

"@mui/monorepo@https://github.com/mui/material-ui.git#master":
version "5.6.3"
resolved "https://github.com/mui/material-ui.git#ab60e53526bf85dd28a64c926839c1fd7ffec6df"

docs/data/pages.ts Outdated Show resolved Hide resolved
Co-authored-by: Andrew Cherniavskii <[email protected]>
@github-actions
Copy link

github-actions bot commented May 6, 2022

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

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

@cherniavskii for the monorepo PR to fix the link, we can avoid temporarily breaking stuff by just handling both links starting now and remove the legacy one later

-          {asPathWithoutLang.startsWith('/x/advanced-components') && (
+          {(asPathWithoutLang.startsWith('/x/advanced-components')  || asPathWithoutLang.startsWith('/x/getting-started')) && (

docs/data/pages.ts Outdated Show resolved Hide resolved
docs/data/getting-started/overview/overview.md Outdated Show resolved Hide resolved
@cherniavskii
Copy link
Member

I've opened mui/material-ui#32657 to address missing product identifier component

@oliviertassinari oliviertassinari removed their request for review June 26, 2022 11:05
Copy link
Contributor Author

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Great job @oliviertassinari! I think this is basically ready to go. 👍

docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Show resolved Hide resolved
- [`@mui/x-data-grid-premium`](https://www.npmjs.com/package/@mui/x-data-grid-premium)

:::info
The features exclusive to the Premium version are marked with the <span class="plan-premium"></span> icon throughout the documentation.
Copy link
Member

Choose a reason for hiding this comment

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

Should we add an example image like we do for pro ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually I'm thinking we should remove the screenshot from the Pro section—I don't think it really adds any value.

Copy link
Member

Choose a reason for hiding this comment

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

Could also make sense, or just inline an example if it's worth it

docs/data/introduction/licensing/licensing.md Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
docs/data/introduction/licensing/licensing.md Outdated Show resolved Hide resolved
Copy link
Member

@joserodolfofreitas joserodolfofreitas left a comment

Choose a reason for hiding this comment

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

This is looking great!
We can merge this to have it published with the next release.
And we can create new PRs for any other improvements.

Copy link
Member

@mbrookes mbrookes left a comment

Choose a reason for hiding this comment

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

Done as far as I'm concerned (sorry, haven't read it again).

@mbrookes
Copy link
Member

mbrookes commented Jul 5, 2022

Merging in 3, 2, 1...

@joserodolfofreitas joserodolfofreitas merged commit 687ca60 into mui:master Jul 7, 2022
flaviendelangle added a commit to flaviendelangle/mui-x that referenced this pull request Jul 7, 2022
joserodolfofreitas added a commit to joserodolfofreitas/mui-x that referenced this pull request Jul 15, 2022
mui#4692)

Co-authored-by: Andrew Cherniavskii <[email protected]>
Co-authored-by: José Rodolfo Freitas <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Matheus Wichman <[email protected]>
Co-authored-by: Flavien Delangle <[email protected]>
alexfauquette pushed a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022
mui#4692)

Co-authored-by: Andrew Cherniavskii <[email protected]>
Co-authored-by: José Rodolfo Freitas <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Matheus Wichman <[email protected]>
Co-authored-by: Flavien Delangle <[email protected]>
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.

9 participants