-
Notifications
You must be signed in to change notification settings - Fork 1.6k
WIP 📖 Revamp migrations guides to reflect current tooling and options #5233
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
base: master
Are you sure you want to change the base?
WIP 📖 Revamp migrations guides to reflect current tooling and options #5233
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
c745375 to
7d7e392
Compare
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.
Pull Request Overview
This PR modernizes the migration documentation by consolidating outdated version-specific migration guides into a single, streamlined document focused on current migration tooling. The changes remove legacy migration guides for v1, v2, and v3 transitions and introduce clear guidance on four migration approaches: automated GitHub Actions updates, local alpha update command, alpha generate for re-scaffolding, and fully manual migration.
Key changes:
- Rewrites
migrations.mdto present modern migration workflows (AutoUpdate plugin, alpha update, alpha generate, manual) - Removes 10+ legacy migration guide files (v1vsv2, v2vsv3, v3vsv4, and related manual migration guides)
- Updates SUMMARY.md to remove navigation entries for deleted legacy guides
- Adds guidance on the PROJECT file's role in automated migrations
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/book/src/migrations.md | Complete rewrite focusing on current migration tooling and workflows with four distinct approaches |
| docs/book/src/SUMMARY.md | Removes navigation entries for legacy migration guides |
| docs/book/src/migration/v3vsv4.md | Deleted legacy v3 to v4 migration comparison |
| docs/book/src/migration/v3-plugins.md | Deleted legacy v3 plugins introduction |
| docs/book/src/migration/multi-group.md | Deleted legacy single-to-multi-group migration guide |
| docs/book/src/migration/migration_guide_gov3_to_gov4.md | Deleted step-by-step v3 to v4 migration guide |
| docs/book/src/migration/manually_migration_guide_gov3_to_gov4.md | Deleted manual v3 to v4 migration guide |
| docs/book/src/migration/legacy/v2vsv3.md | Deleted v2 to v3 comparison |
| docs/book/src/migration/legacy/v1vsv2.md | Deleted v1 to v2 comparison |
| docs/book/src/migration/legacy/migration_guide_v2tov3.md | Deleted v2 to v3 migration guide |
| docs/book/src/migration/legacy/migration_guide_v1tov2.md | Deleted v1 to v2 migration guide |
| docs/book/src/migration/legacy/manually_migration_guide_v2_v3.md | Deleted manual v2 to v3 migration guide |
| docs/book/src/migration/legacy.md | Deleted legacy migrations introduction |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8a17330 to
1697ea4
Compare
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.
Pull Request Overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ff7c5d9 to
435bbd9
Compare
435bbd9 to
d332b2a
Compare
01e0d6f to
f430eee
Compare
f430eee to
df05a98
Compare
df05a98 to
cb291c5
Compare
Removes outdated information and clarifies when each approach should be used. Adds guidance on the PROJECT file and its role in automation.