Skip to content

docs(setup): fix pre-Magpie migration steps that became no-ops#877

Merged
potiuk merged 1 commit into
apache:mainfrom
zbl1998-sdjn:docs/fix-pre-magpie-migration-noop
Jul 15, 2026
Merged

docs(setup): fix pre-Magpie migration steps that became no-ops#877
potiuk merged 1 commit into
apache:mainfrom
zbl1998-sdjn:docs/fix-pre-magpie-migration-noop

Conversation

@zbl1998-sdjn

@zbl1998-sdjn zbl1998-sdjn commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

The "Migrating a pre-Magpie adopter" recipe in docs/setup/install-recipes.md got caught by the apache-stewardapache-magpie rename: 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-steward in the heading, intro, step 1, step 2's overrides-preserve clause, and step 3; the destination paths stay apache-magpie. I took the direction from d856ce2 (#440), which moved the XDG dir ~/.config/apache-steward/~/.config/apache-magpie/ — still what skills/setup/upgrade.md does today. The TOC anchor is updated to match the renamed heading.

Test plan

  • git diff is +11/-11, all inside the one section.
  • doctoc regenerates the TOC with no change, and nothing else in the repo links to the old anchor.
  • I didn't run the full prek locally — happy to fix anything doctoc / markdownlint / lychee flags.

Fixes #867

Copilot AI review requested due to automatic review settings July 15, 2026 14:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-steward as 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.

Comment thread docs/setup/install-recipes.md
Comment thread docs/setup/install-recipes.md
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
@zbl1998-sdjn zbl1998-sdjn force-pushed the docs/fix-pre-magpie-migration-noop branch from 5fb200f to a15689f Compare July 15, 2026 16:08
@potiuk potiuk merged commit 4279441 into apache:main Jul 15, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/setup/install-recipes.md: migration step 3 is a no-op (path typo)

3 participants