From d0f535d4135c3d7ffa4e71b78514cbe5beeacbd5 Mon Sep 17 00:00:00 2001 From: Bilal Shafi Date: Thu, 24 Oct 2024 18:46:11 +0500 Subject: [PATCH] [docs] Start v8 migration guides (#15096) --- .../migration-charts-v7.md | 34 ++++++++ .../migration-data-grid-v7.md | 78 +++++++++++++++++++ .../migration-pickers-v7.md | 2 + .../migration-tree-view-v7.md | 2 + docs/data/pages.ts | 5 ++ docs/pages/x/migration/migration-charts-v7.js | 7 ++ .../x/migration/migration-data-grid-v7.js | 7 ++ 7 files changed, 135 insertions(+) create mode 100644 docs/data/migration/migration-charts-v7/migration-charts-v7.md create mode 100644 docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md create mode 100644 docs/pages/x/migration/migration-charts-v7.js create mode 100644 docs/pages/x/migration/migration-data-grid-v7.js diff --git a/docs/data/migration/migration-charts-v7/migration-charts-v7.md b/docs/data/migration/migration-charts-v7/migration-charts-v7.md new file mode 100644 index 0000000000000..a23f9406feff9 --- /dev/null +++ b/docs/data/migration/migration-charts-v7/migration-charts-v7.md @@ -0,0 +1,34 @@ +--- +productId: x-charts +--- + +# Migration from v7 to v8 + +

This guide describes the changes needed to migrate Charts from v7 to v8.

+ +## 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. +::: diff --git a/docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md b/docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md new file mode 100644 index 0000000000000..eea548d0fbc03 --- /dev/null +++ b/docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md @@ -0,0 +1,78 @@ +--- +productId: x-data-grid +--- + +# Migration from v7 to v8 + +

This guide describes the changes needed to migrate the Data Grid from v7 to v8.

+ +## 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. +::: + + diff --git a/docs/data/migration/migration-pickers-v7/migration-pickers-v7.md b/docs/data/migration/migration-pickers-v7/migration-pickers-v7.md index c5a7a72d92f34..06190e91328c7 100644 --- a/docs/data/migration/migration-pickers-v7/migration-pickers-v7.md +++ b/docs/data/migration/migration-pickers-v7/migration-pickers-v7.md @@ -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. diff --git a/docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md b/docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md index d632274109026..c766981007264 100644 --- a/docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md +++ b/docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md @@ -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. diff --git a/docs/data/pages.ts b/docs/data/pages.ts index 0315101ba4490..bae512de29409 100644 --- a/docs/data/pages.ts +++ b/docs/data/pages.ts @@ -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', @@ -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', + }, ], }, { diff --git a/docs/pages/x/migration/migration-charts-v7.js b/docs/pages/x/migration/migration-charts-v7.js new file mode 100644 index 0000000000000..09b47f90866e3 --- /dev/null +++ b/docs/pages/x/migration/migration-charts-v7.js @@ -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 ; +} diff --git a/docs/pages/x/migration/migration-data-grid-v7.js b/docs/pages/x/migration/migration-data-grid-v7.js new file mode 100644 index 0000000000000..454b6a6e813e5 --- /dev/null +++ b/docs/pages/x/migration/migration-data-grid-v7.js @@ -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 ; +}