Skip to content

Commit

Permalink
[docs] Start v8 migration guides (#15096)
Browse files Browse the repository at this point in the history
  • Loading branch information
MBilalShafi authored Oct 24, 2024
1 parent 0f3eb1e commit d0f535d
Show file tree
Hide file tree
Showing 7 changed files with 135 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/data/migration/migration-charts-v7/migration-charts-v7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
productId: x-charts
---

# Migration from v7 to v8

<p class="description">This guide describes the changes needed to migrate Charts from v7 to v8.</p>

## Introduction

This is a reference guide for upgrading `@mui/x-charts` from v7 to v8.
The change between v7 and v8 is mostly here to match the version with other MUI X packages.
No big breaking changes are expected.

## Start using the new release

In `package.json`, change the version of the charts package to `next`.

```diff
-"@mui/x-charts": "^7.0.0",
+"@mui/x-charts": "next",
```

Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`.

## Breaking changes

Since v8 is a major release, it contains some changes that affect the public API.
These changes were done for consistency, improve stability and make room for new features.
Below are described the steps you need to make to migrate from v7 to v8.

:::info
The list is currently empty, but as we move forward with development during the alpha and beta phases, we'll feed this page with all changes in the API.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
productId: x-data-grid
---

# Migration from v7 to v8

<p class="description">This guide describes the changes needed to migrate the Data Grid from v7 to v8.</p>

## Introduction

This is a reference guide for upgrading `@mui/x-data-grid` from v7 to v8.

## Start using the new release

In `package.json`, change the version of the Data Grid package to `next`.

```diff
-"@mui/x-data-grid": "^7.0.0",
+"@mui/x-data-grid": "next",

-"@mui/x-data-grid-pro": "^7.0.0",
+"@mui/x-data-grid-pro": "next",

-"@mui/x-data-grid-premium": "^7.0.0",
+"@mui/x-data-grid-premium": "next",
```

Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`.

## Breaking changes

Since v8 is a major release, it contains some changes that affect the public API.
These changes were done for consistency, improve stability and make room for new features.
Below are described the steps you need to make to migrate from v7 to v8.

:::info
The list is currently empty, but as we move forward with development during the alpha and beta phases, we'll feed this page with all changes in the API.
:::

<!-- ### Columns
TBD
### Rows
TBD
### `apiRef` methods
TBD
### Selection
TBD
### Accessibility
TBD
### Editing
TBD
### Other exports
TBD
### CSS classes and styling
TBD
### Changes to the public API
TBD
### Changes to slots
TBD -->
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ In `package.json`, change the version of the date pickers package to `next`.
+"@mui/x-date-pickers": "next",
```

Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`.

Since `v8` is a major release, it contains changes that affect the public API.
These changes were done for consistency, improved stability and to make room for new features.
Described below are the steps needed to migrate from v7 to v8.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ In `package.json`, change the version of the Tree View package to `next`.
+"@mui/x-tree-view": "next",
```

Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`.

Since `v8` is a major release, it contains changes that affect the public API.
These changes were done for consistency, improved stability and to make room for new features.
Described below are the steps needed to migrate from v7 to v8.
Expand Down
5 changes: 5 additions & 0 deletions docs/data/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,7 @@ const pages: MuiPage[] = [
pathname: '/x/migration-v8',
subheader: 'Upgrade to v8',
children: [
{ pathname: '/x/migration/migration-data-grid-v7', title: 'Breaking changes: Data Grid' },
{
pathname: '/x/migration/migration-pickers-v7',
title: 'Breaking changes: Date and Time Pickers',
Expand All @@ -549,6 +550,10 @@ const pages: MuiPage[] = [
pathname: '/x/migration/migration-tree-view-v7',
title: 'Breaking changes: Tree View',
},
{
pathname: '/x/migration/migration-charts-v7',
title: 'Breaking changes: Charts',
},
],
},
{
Expand Down
7 changes: 7 additions & 0 deletions docs/pages/x/migration/migration-charts-v7.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import * as pageProps from 'docsx/data/migration/migration-charts-v7/migration-charts-v7.md?muiMarkdown';

export default function Page() {
return <MarkdownDocs {...pageProps} />;
}
7 changes: 7 additions & 0 deletions docs/pages/x/migration/migration-data-grid-v7.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import * as pageProps from 'docsx/data/migration/migration-data-grid-v7/migration-data-grid-v7.md?muiMarkdown';

export default function Page() {
return <MarkdownDocs {...pageProps} />;
}

0 comments on commit d0f535d

Please sign in to comment.