diff --git a/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/introduction.md b/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/introduction.md new file mode 100644 index 0000000000..a26ab17982 --- /dev/null +++ b/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/introduction.md @@ -0,0 +1,13 @@ +--- +title: Additional resources for migrating to Strapi 5 +sidebar_label: Introduction +displayed_sidebar: devDocsMigrationV5Sidebar +--- + +# Additional resources for migrating to Strapi 5 + +The following pages cover some specific topics for migrating to Strapi 5 that have not been covered neither in the [CLI upgrade tool](/dev-docs/migration/v4-to-v5/use-the-upgrade-tool) guide nor in the list of [breaking changes](/dev-docs/migration/v4-to-v5/breaking-changes): + + + + diff --git a/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/plugins-migration.md b/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/plugins-migration.md new file mode 100644 index 0000000000..2594d6e8f7 --- /dev/null +++ b/docusaurus/docs/dev-docs/migration/v4-to-v5/guides/plugins-migration.md @@ -0,0 +1,50 @@ +--- +title: Plugins migration reference +displayed_sidebar: devDocsMigrationV5Sidebar +--- + +# Plugins migration summary + +:::callout 🚧 Work in progress +This page is a work-in-progress and some links are currently missing. +::: + +The present page is intended to be used as a short summary of everything to consider if you are a plugin developer intending to migrate your plugin from Strapi v4 to Strapi 5. The page quickly describes the changes affecting plugins and link to additional resources where necessary. + +## Back-end changes + +- The Entity Service API from Strapi v4 is deprecated and Strapi 5 uses the [Document Service API](/dev-docs/api/document-service) instead. A [migration guide](/dev-docs/migration/v4-to-v5/guides/from-entity-service-to-document-service) is available to help you transition to the Document Service API. +- General Strapi v4 to Strapi 5 [breaking changes](/dev-docs/migration/v4-to-v5/breaking-changes) might apply. +- You can use the new [Plugin CLI](/dev-docs/plugins/guides/use-the-plugin-cli) to generate plugins and publish them on NPM and/or submit them to the Marketplace. + +## Front-end changes + +- The Design System is upgraded to v2 in Strapi 5: + + - There are no big visual changes, except for [icons](#).
(_the link will be added in the upcoming weeks_) + + - A migration guide will be [available](#).
(_the link will be added in the upcoming weeks_) + + - A list of breaking changes specific to the Design System will be available in the [Design System documentation](#).
(_the link will be added in the upcoming weeks_) + - General Strapi v4 to Strapi 5 [breaking changes](/dev-docs/migration/v4-to-v5/breaking-changes) might apply. +- The `helper-plugin` is deprecated. A [migration reference](/dev-docs/migration/v4-to-v5/guides/helper-plugin) is available to help you transition away from the `helper-plugin`. +- Strapi does not alias dependencies any longer. The 4 dependencies that are expected to be used by all client facing code are declared at the project level (react/react-dom/styled-components & react-router-dom). If you do not declare your dependencies that you use e.g. `axios` there's a likelihood users could face unforeseen issues with your plugin. + + + + +## Custom providers + +Custom [providers](/dev-docs/providers) for the Email and Upload plugins need conversion only if they were using the Entity Service API (please refer to the [Entity Service API to Document Service API migration guide](/dev-docs/migration/v4-to-v5/guides/from-entity-service-to-document-service)). diff --git a/docusaurus/docs/dev-docs/migration/v4-to-v5/introduction.md b/docusaurus/docs/dev-docs/migration/v4-to-v5/introduction.md index be33e98592..96b1a5c6cc 100644 --- a/docusaurus/docs/dev-docs/migration/v4-to-v5/introduction.md +++ b/docusaurus/docs/dev-docs/migration/v4-to-v5/introduction.md @@ -14,8 +14,10 @@ It is currently strongly advised that you refrain from migrating from Strapi v4 The beta version of Strapi 5 is not meant to be used in production yet. ::: -The [upgrade tool](/dev-docs/upgrade-tool) and its codemods should automate some parts of the migration from v4 to Strapi 5. Additional information is also given below about breaking changes. +The [upgrade tool](/dev-docs/upgrade-tool) and its codemods should automate some parts of the migration from v4 to Strapi 5. Additional information is also given below about breaking changes and dedicated migration resources for specific topics. - + + + diff --git a/docusaurus/docs/dev-docs/migration/v4-to-v5/use-the-upgrade-tool.md b/docusaurus/docs/dev-docs/migration/v4-to-v5/use-the-upgrade-tool.md new file mode 100644 index 0000000000..226570ba17 --- /dev/null +++ b/docusaurus/docs/dev-docs/migration/v4-to-v5/use-the-upgrade-tool.md @@ -0,0 +1,6 @@ +--- +title: Migrate to Strapi 5 with the CLI upgrade tool +displayed_sidebar: devDocsMigrationV5Sidebar +--- + +_Coming soon…_ diff --git a/docusaurus/docs/dev-docs/plugins/guides/use-the-plugin-cli.md b/docusaurus/docs/dev-docs/plugins/guides/use-the-plugin-cli.md index 7bb7fb85fd..10bd1eb07c 100644 --- a/docusaurus/docs/dev-docs/plugins/guides/use-the-plugin-cli.md +++ b/docusaurus/docs/dev-docs/plugins/guides/use-the-plugin-cli.md @@ -9,12 +9,6 @@ import NotV5 from '/docs/snippets/_not-updated-to-v5.md' # How to use the Plugin CLI to create and publish a Strapi plugin - - -:::caution -The Plugin CLI is currently experimental. -::: - The Plugin CLI is set of commands orientated around developing plugins to use them as local plugins or to publish them on NPM and/or submit them to the Marketplace. As opposed to the `strapi generate plugin` command (see [plugin creation and setup](/dev-docs/plugins/development/create-a-plugin)) you do not need to set up a Strapi project to use the Plugin CLI. diff --git a/docusaurus/sidebars.js b/docusaurus/sidebars.js index bbb5d0fdb0..4545533c41 100644 --- a/docusaurus/sidebars.js +++ b/docusaurus/sidebars.js @@ -1227,7 +1227,10 @@ const sidebars = { { type: 'category', label: 'Migration guides', + link: { type: 'doc', id: 'dev-docs/migration/v4-to-v5/guides/introduction' }, items: [ + 'dev-docs/migration/v4-to-v5/guides/introduction', + 'dev-docs/migration/v4-to-v5/guides/plugins-migration', 'dev-docs/migration/v4-to-v5/guides/helper-plugin', 'dev-docs/migration/v4-to-v5/guides/from-entity-service-to-document-service', ]