Skip to content

Conversation

@MbonuJennifer
Copy link
Contributor

In this PR:

Updated information on Apollo Server v3 upgraded to Apollo Server v4 in Strapi 5.

@MbonuJennifer MbonuJennifer added source: Dev Docs PRs/issues targeting the Developer Docs internal PRs created by the Strapi core team v5 Documentation PR that targets Strapi v5 labels Mar 13, 2024
@MbonuJennifer MbonuJennifer added this to the 5.0.0-beta milestone Mar 13, 2024
@MbonuJennifer MbonuJennifer self-assigned this Mar 13, 2024
@MbonuJennifer MbonuJennifer requested a review from pwizla as a code owner March 13, 2024 10:53
@strapi-cla
Copy link

strapi-cla commented Mar 13, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ pwizla
❌ MbonuJennifer
You have signed the CLA already but the status is still pending? Let us recheck it.

@vercel
Copy link

vercel bot commented Mar 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2024 5:26pm


### Notes

- The migration process for user code and configuration is too complicated for Strapi to cover completely.
Copy link
Collaborator

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)."


### Manual migration

To migrate to Strapi 5:
Copy link
Collaborator

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!

Copy link
Collaborator

@pwizla pwizla left a 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!

@pwizla pwizla merged commit cd295d2 into next Mar 19, 2024
@pwizla pwizla deleted the v5/bc--upgrade-to-apollov4 branch March 19, 2024 17:17
@pwizla pwizla modified the milestones: 5.0.0-beta, 5.0.0 (stable) Jun 12, 2024
@pwizla pwizla modified the milestones: 5.0.0 (stable), 5.0.0-rc.0 Jun 26, 2024
@pwizla pwizla modified the milestones: 5.0.0-rc.0, 5.0.0 (stable) Aug 13, 2024
@pwizla pwizla added the pr: new content PRs for new product features or new documentation sections label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections source: Dev Docs PRs/issues targeting the Developer Docs v5 Documentation PR that targets Strapi v5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants