feat: Configure docs for migration to canonical.com (add migration branch for main)#752
Draft
skoech wants to merge 4 commits into
Draft
feat: Configure docs for migration to canonical.com (add migration branch for main)#752skoech wants to merge 4 commits into
skoech wants to merge 4 commits into
Conversation
skoech
changed the title
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
11 tasks
skoech
added a commit
that referenced
this pull request
Jul 6, 2026
# Description This PR updates the MicroCeph docs to the latest version of the Sphinx Stack (v2.0). It brings in updated tooling, and adds missing CI checks. - Fixes #678 - Potentially fixes domain migration issue: (related to #752) ## Key changes - Syncs `conf.py` with the latest Sphinx Stack template - Syncs GitHub workflows with Sphinx Stack (`cla-check.yml`, `check-removed-urls.yml`) - Replaces bundled extension dependencies with individual packages in `requirements.txt` - Adds `redirects.txt` since Sphinx Stack 2.0 deprecates the `sphinx-reredirects` extension, which defines redirects inline, in favor of `sphinx-rerediraffe`, which requires redirects to live in a separate `redirects.txt` file - Removes redirects dict from `conf.py` - Changes `FETCH_SCRIPT` variable from `SOURCEDIR` to `DOCS_SOURCEDIR` in `Makefile` - Adds `_dev/` directory with updated tooling (pre-commit hooks, Vale config, pa11y script, pymarkdown) - renamed from `_.sphinx` to better reflect its purpose (**breaking change**) - Removes the `reuse/` directory to reduce complexity and improve source readability (**breaking change**) ### Features - **sphinx-llm support**: Adds `sphinx-llm` extension that generates extra files (`llms.txt`, `llms-full.txt`, `.md` copies of each page) alongside regular HTML build, that are optimized for AI tools. This makes the documentation consumable by LLMs and MCP-based tools. - **Dependency constraints**: All extensions are now pinned to their major version to prevent upstream breakages from surprise releases. Most extensions now uses the `~=` operator (compatible release), which locks to the current major version, which means that we'd still get minor updates (e.g., bug fixes, security fixes and minor improvements/features) without risking a surprise breaking change. - **Copyright statement**: Footer now includes license metadata (AGPL-3.0)- added to `html_context` in `conf.py`. Sphinx Stack 2.0 aligns the copyright statement with legal standards Release notes: https://github.com/canonical/sphinx-stack/releases ## Type of change - Documentation update (change to documentation only) - Documentation tooling, specifically, not content ## How has this been tested? Tested locally; builds pass with no errors or warnings: - [x] `make run`: Builds and serves successfully - [x] `make spelling`: No spelling errors; Ceph-specific terms caught added to `.custom_wordlist.txt` - [x] `make woke`: No inclusive language issues - [x] `make linkcheck`: No broken links <img width="1850" height="941" alt="image" src="https://github.com/user-attachments/assets/19b28082-7742-471e-8984-ec9f896828b2" /> <img width="1850" height="941" alt="image" src="https://github.com/user-attachments/assets/835bcdea-af88-4e8d-8e6e-1f809237554a" /> ## Contributor checklist - [x] self-reviewed the code in this PR - [x] added code comments, particularly in less straightforward areas - [ ] checked and added or updated relevant documentation - N/A - [ ] added or updated HTML meta descriptions for any new or modified documentation pages (see [#643](#643)) - N/A - [ ] verified that page title and headings accurately represent page content for new or modified documentation pages - N/A - [ ] checked and added or updated relevant release notes - [ ] added tests to verify effectiveness of this change --------- Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
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
1 participant
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.
No description provided.