Add scope and warning details to the upgrade tool guide #2195
Conversation
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
Introduce the scope section outlining the upgrade tool's capabilities and limitations. Add warnings about reviewing modifications after the upgrade and backing up the codebase and database before running the upgrade process.
Convly added source: Dev Docs 
| The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
pwizla reviewed Sep 5, 2024
pwizla reviewed Sep 5, 2024
pwizla reviewed Sep 5, 2024
pwizla reviewed Sep 5, 2024
pwizla reviewed Sep 5, 2024
pwizla approved these changes Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
What does it do?
Add scope and warning details to the upgrade tool guide
Introduce the scope section outlining the upgrade tool's capabilities and limitations.
Add warnings about reviewing modifications after the upgrade and backing up the codebase and database before running the upgrade process.
Why is it needed?
Mitigate expectations around the upgrade tool, create reference points to redirect users to in case of doubts.
It's also expected to lower the risk of having issues created around wrong expectations.