Add federated redirect map
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 2
- Forks
- 17
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 3
Description
Create a mechanism that allows individual repositories to declare redirects for its own files.
This makes it safer to rename/move pages and re-organize structure.
We should add a generic pulp-docs configuration file, because there might be other federated features we can add in the future.
It could be something like pulpdocs.toml and have a section [[ redirects ]].
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by defining the proposed pulpdocs.toml structure, including the [[redirects]] section, and determine how an individual repository will declare redirects for its files. Done means repositories can safely preserve redirects when documentation pages are renamed, moved, or reorganized, with the configuration extensible for future federated features.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100