Skip to content

Commit

Permalink
[docs] Revise and split up "Overview" page into "Introduction" section (
Browse files Browse the repository at this point in the history
#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]>
  • Loading branch information
7 people authored Jul 7, 2022
1 parent ffd1940 commit 687ca60
Show file tree
Hide file tree
Showing 21 changed files with 375 additions and 223 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The community isn't contributing improvements as fast as the problems deserved t
We are using a commercial license to forward the development of the most advanced features, where the MIT model can't sustain it.
A feature should only be commercial if it has no great MIT alternatives.

Find more details [on the docs](https://mui.com/x/advanced-components/#licenses).
Find more details [in the docs](https://mui.com/x/introduction/licensing/).

- [DataGrid](https://mui.com/components/data-grid/), published under `@mui/x-data-grid`, MIT licensed.
- [DataGridPro](https://mui.com/components/data-grid/#commercial-version), published under `@mui/x-data-grid-pro`, commercially licensed.
Expand Down
211 changes: 0 additions & 211 deletions docs/data/advanced-components/overview.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/data/data-grid/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The component comes [in different plans](https://mui.com/pricing/):
- **Pro** Plan: [`@mui/x-data-grid-pro`](https://www.npmjs.com/package/@mui/x-data-grid-pro) published under a [Commercial license](https://mui.com/store/legal/mui-x-eula/).
- **Premium** Plan: [`@mui/x-data-grid-premium`](https://www.npmjs.com/package/@mui/x-data-grid-premium) published under a [Commercial license](https://mui.com/store/legal/mui-x-eula/).

More information about the various plans on [the dedicated section](/x/advanced-components/#plans)
You can find more information about the plans in [the Licensing page](/x/introduction/licensing/).

### Feature comparison

Expand Down
4 changes: 2 additions & 2 deletions docs/data/data-grid/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The component leverages the power of React and TypeScript, to provide the best U
> Visit the [installation guide](/x/react-data-grid/getting-started/#installation) to learn how to install the correct package version and dependencies.
Data tables display information in a grid-like format of rows and columns.
They organize information in a way thats easy to scan so that users can look for patterns and insights.
They organize information in a way that's easy to scan so that users can look for patterns and insights.

The data grid comes in two different versions:

Expand Down Expand Up @@ -66,7 +66,7 @@ import { DataGridPremium } from '@mui/x-data-grid-premium';

### MIT vs. commercial

> Please check the [Licenses section](/x/advanced-components/#licenses) for more details between the different versions.
Please see [the Licensing page](/x/introduction/licensing/) for details.

## Features

Expand Down
2 changes: 1 addition & 1 deletion docs/data/date-pickers/migration-lab/migration-lab.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ import { LicenseInfo } from '@mui/x-license-pro';
LicenseInfo.setLicenseKey('YOUR_LICENSE_KEY');
```

More information [here](/x/advanced-components/#license-key-installation)
Learn more on [the Licensing page](/x/introduction/licensing/#license-key-installation).

### 2. Run the code mod

Expand Down
22 changes: 22 additions & 0 deletions docs/data/introduction/installation/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Installation

<p class="description">Install the necessary packages to start building with MUI X components.</p>

MUI X packages are available through the free MIT-licensed Community Plan, or the commercially-licensed Pro and Premium Plans.
See [the licensing page](/x/introduction/licensing/) for complete details.

## Peer dependencies

MUI X components have a peer dependency on `@mui/material`: the installation [instructions](/material-ui/getting-started/installation/).

## Components

Note that you only need to install the packages corresponding to the components you're using—e.g. data grid users don't need to install date and time pickers.

### Data grid

The installation [instructions](/x/react-data-grid/getting-started/#installation).

### Date and Time pickers

The installation [instructions](/x/react-date-pickers/getting-started/#setup).
Loading

0 comments on commit 687ca60

Please sign in to comment.