-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[Strapi 5] Breaking change for upgrade from apollo v3 to apollo v4 #2053
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
Conversation
|
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docusaurus/docs/dev-docs/migration/v4-to-v5/breaking-changes/upgrade-to-apollov4.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/dev-docs/migration/v4-to-v5/breaking-changes/upgrade-to-apollov4.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Notes | ||
|
|
||
| - The migration process for user code and configuration is too complicated for Strapi to cover completely. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please never write something is easy or difficult. This is left to the users' appreciation. See our 12 rules in the handbook.
Rewrite this with a different tone, something like: "For detailed instructions on how to migrate to Apollo v4, please refer to Apollo official docs (+ add external link here)."
docusaurus/docs/dev-docs/migration/v4-to-v5/breaking-changes/upgrade-to-apollov4.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Manual migration | ||
|
|
||
| To migrate to Strapi 5: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section should only contain instructions and procedures.
Most of the sentences from the bullet points that you wrote describe differences, not what the user should actually do. Rewrite the sentences that the user knows what to do.
If you miss some information, please ask Ben Irvin, or if he's too busy at the moment, move these sentences to the Notes section and write something really generic in the Manual migration section, such as "To migrate to Strapi 5, users should manually update their code, taking into account all the items listed in the Notes section."
If you do this (i.e., do not actually describe what people can do), please also add a TODO comment in the Markdown file so we make sure we get back to it later and improve the manual migration section. Thank you!
pwizla
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, Jennifer!
This breaking change item was not easy to handle.
The PR needs rework. I left several comments as a guidance. Hope that helps!
In this PR:
Updated information on Apollo Server v3 upgraded to Apollo Server v4 in Strapi 5.