Create tooling to move documentation source files

[bmorelli25]

Summary

Moving files within a complex content set is currently one of the most time-consuming aspects of authoring. During the migration freeze period, this challenge will be amplified as writers move many pages to finalize our new IA and user experience.

Currently, in docs-builder, moving a file to a new location requires the following manual steps:

1. Move the file to its new location.
2. Update the toc.yml file: Remove the file from the old location and add it to the new one.
3. Update outgoing links: Ensure all links in the moved file pointing to other pages are updated.
4. Update incoming links: Ensure all links from other pages pointing to the moved file are updated.

The Ask

Provide tooling that automates file movement within the same content set.

When a writer uses this tool, it should:

• Automatically move the file to the new location.
• Update the toc.yml file.
• Update all outgoing links from the moved file.
• Update all incoming links to the moved file.

This tool would:

• Significantly reduce the time required to move content.
• Help ensure accuracy and prevent broken links as writers reorganize content.
• Streamline the migration process during the freeze period, allowing the team to focus on finalizing the IA and improving the user experience.

[Mpdreamz]

++ this is sorely needed.

One thing I'd like to build is

docs-builder apply-renames

This allows devs to to just move files with e.g

git mv docs/configure/ configure2

and git add them or even commit and we'd pick up all renames with:

git diff -M --staged --name-status
git show -M --name-status

And update all references of them.

The other thing is we want to record the renames in our links.json artifact too.

[bmorelli25]

I think that is an ideal long-term solution. In my conversation with Jan, he suggested that creating a move tool might be easier to do in the short term to potentially have something ready for migration.

[reakaleek]

refs:

• Add docs-builder mv command #376
• Add move to target folder support to mv command #383
• Implement whole folder moves to the mv command #385