-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Plugins migration summary #2089
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
docusaurus/docs/dev-docs/migration/v4-to-v5/guides/introduction.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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): | ||
|
|
||
| <CustomDocCard emoji="📦" title="Entity Service API to Document Service API migration reference" description="Learn how to transition from the Entity Service API, deprecated in Strapi 5, to the new Document Service API." link="/dev-docs/migration/v4-to-v5/guides/from-entity-service-to-document-service" /> | ||
| <CustomDocCard emoji="🧩" title="Plugins migration summary" description="Find all resources and answers to your questions on how to migrate your plugins to Strapi 5." link="/dev-docs/migration/v4-to-v5/guides/plugins-migration" /> | ||
| <CustomDocCard emoji="💁" title="Helper-plugin deprecation reference" description="Learn how to develop plugins with the Strapi v4 helper-plugin that has been removed in Strapi 5." link="/dev-docs/migration/v4-to-v5/guides/helper-plugin" /> |
50 changes: 50 additions & 0 deletions
50
docusaurus/docs/dev-docs/migration/v4-to-v5/guides/plugins-migration.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
| <!-- TODO: add link to icons in Design System v2 --> | ||
| - There are no big visual changes, except for [icons](#).<br/>(_the link will be added in the upcoming weeks_) | ||
| <!-- TODO: add link to migration guide --> | ||
| - A migration guide will be [available](#).<br/>(_the link will be added in the upcoming weeks_) | ||
| <!-- TODO: add link to breaking changes --> | ||
| - A list of breaking changes specific to the Design System will be available in the [Design System documentation](#).<br/>(_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. | ||
|
|
||
| <!-- TODO: clarify these 👇--> | ||
| <!-- ## General changes | ||
|
|
||
| - Building and packaging? | ||
| - They don’t have to do it (not tested) | ||
| - Recommended as a best practices (from npm) | ||
| - Pack up? | ||
| - Not required | ||
| - Is pack up specific to our packages or is it universal | ||
| - More for libraries | ||
| - Does the plugin need to be a TS one to use pack up (honestly no idea what pack up does) | ||
| - peerDepend requirement? | ||
| - Yes probably (ask emilie) | ||
| - As a peerDepend --> | ||
|
|
||
| ## 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)). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
docusaurus/docs/dev-docs/migration/v4-to-v5/use-the-upgrade-tool.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: Migrate to Strapi 5 with the CLI upgrade tool | ||
| displayed_sidebar: devDocsMigrationV5Sidebar | ||
| --- | ||
|
|
||
| _Coming soon…_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.