docs(setup): fix pre-Magpie migration steps that became no-ops#877
Merged
potiuk merged 1 commit intoJul 15, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the pre-Magpie migration recipe to correctly describe the legacy apache-steward layout as the source side of the rename, fixing a previously documented no-op directory move and aligning the section heading/TOC anchor with the legacy naming.
Changes:
- Restores
apache-stewardas the legacy source-side name throughout the “Migrating a pre-Magpie … adopter” section. - Fixes the migration step that previously moved
~/.config/apache-magpie/to itself by documenting~/.config/apache-steward/→~/.config/apache-magpie/. - Updates the doctoc entry/anchor to match the renamed heading.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The "Migrating a pre-Magpie adopter" section in docs/setup/install-recipes.md tells an adopter how to move off the old apache-steward layout, but the steward -> magpie rename sweep also replaced the source-side names. The steps now move/rename paths to themselves; step 3 reads "move ~/.config/apache-magpie/ to ~/.config/apache-magpie/", a no-op. Restore the old-layout (source-side) names to apache-steward. The mapping is the one recorded in d856ce2 (apache#440): the XDG config dir moved ~/.config/apache-steward/ -> ~/.config/apache-magpie/, and it is still the migration skills/setup/upgrade.md performs. Destination paths stay apache-magpie. Applies the same source-side fix to the section heading/intro, step 1, and step 2's overrides-preserve clause; the TOC anchor is updated to match the renamed heading. Fixes apache#867
5fb200f to
a15689f
Compare
potiuk
approved these changes
Jul 15, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The "Migrating a pre-Magpie adopter" recipe in
docs/setup/install-recipes.mdgot caught by theapache-steward→apache-magpierename: the source-side (old-layout) names were renamed too, so the steps now move/rename paths to themselves. Step 3 — "move~/.config/apache-magpie/to~/.config/apache-magpie/" — is the no-op in #867.This restores the old-layout names to
apache-stewardin the heading, intro, step 1, step 2's overrides-preserve clause, and step 3; the destination paths stayapache-magpie. I took the direction from d856ce2 (#440), which moved the XDG dir~/.config/apache-steward/→~/.config/apache-magpie/— still whatskills/setup/upgrade.mddoes today. The TOC anchor is updated to match the renamed heading.Test plan
git diffis +11/-11, all inside the one section.doctocregenerates the TOC with no change, and nothing else in the repo links to the old anchor.preklocally — happy to fix anything doctoc / markdownlint / lychee flags.Fixes #867