docs: migrate docs hosting site to ubuntu.com/docs (Infra)#2718
Open
tang-mm wants to merge 6 commits into
Open
docs: migrate docs hosting site to ubuntu.com/docs (Infra)#2718tang-mm wants to merge 6 commits into
tang-mm wants to merge 6 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx documentation configuration and theme assets to support hosting Checkbox docs at ubuntu.com/docs/checkbox, including new Canonical header/footer templates and a small JS helper for ReadTheDocs flyout link rewriting.
Changes:
- Update
docs/conf.pyfor newubuntu.com/docs/checkboxbase URLs, slug, templates, and JS inclusion. - Add Canonical header/footer HTML templates and a JS file to rewrite RTD flyout links to the new domain.
- Update the homepage related-links metadata to point to the project repository.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.rst | Updates :relatedlinks: entry shown on the docs home page |
| docs/conf.py | Adjusts docs site URL/base URL, enables templates, adds JS, and sets ubuntu.com slug |
| docs/.sphinx/_templates/header.html | Adds Canonical navigation header + GTM snippet |
| docs/.sphinx/_templates/footer.html | Adds Canonical footer structure + cookie/tracker settings link |
| docs/.sphinx/_static/overwrite_links.js | Rewrites RTD-hosted links in the flyout to the ubuntu.com/docs domain |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request updates the Checkbox documentation configuration and assets to align with its new hosting location at
ubuntu.com/docs/checkbox.Description
Changes following the migration guide at https://github.com/canonical/RTD-Proxy/blob/main/docs/how-to/migrate.rst
docs/conf.pyto use the newubuntu.com/docs/checkboxdomain,overwrite_links.jsto support dynamically generated links in the ReadTheDocs flyout (version indicator in the bottom-right corner) to point to the new domain. This does not affect the current domain.Resolved issues
CDOC-370
Documentation
N/A (refer to the original migration guide)
Tests
Manual validation on staging at
staging.ubuntu.com/docs/checkbox(requires VPN)Related proxy configuration in Launchpad: