docs: add settings for domain migration#342
Open
elijahgreenstein wants to merge 5 commits into
Open
Conversation
Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Sets up MicroOVN docs at `ubuntu.com/docs/microovn`. Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx/Read the Docs configuration and bundled static assets to support migrating the MicroOVN documentation from the Read the Docs hosted domain to https://ubuntu.com/docs/microovn/, including sitemap generation and cookie/analytics tooling.
Changes:
- Adds URL/base-url configuration in
docs/conf.py, enablessphinx_sitemap, and includes new static JS/CSS assets. - Updates RTD build configuration to support sitemap
lastmod(via full git history) and to cancel PR builds when docs are unchanged. - Adds templates/static assets for Google Tag Manager and a cookie/tracker settings UI, plus JS to rewrite flyout links to the new domain.
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/conf.py | Adds base URL/version-aware settings, enables sitemap extension, and includes new JS/CSS assets. |
| docs/.sphinx/requirements.txt | Adds sphinx-sitemap dependency for sitemap generation. |
| docs/.sphinx/_templates/header.html | Injects Google Tag Manager snippet into the docs header. |
| docs/.sphinx/_templates/footer.html | Adds “Manage your tracker settings” trigger link to the footer. |
| docs/.sphinx/_static/overwrite_links.js | Adds runtime rewriting of RTD flyout/menu links from old domain to new domain. |
| docs/.sphinx/_static/cookie-banner.css | Adds cookie banner / tracker settings modal styling. |
| docs/.sphinx/_static/bundle.js | Adds bundled/minified cookie/tracker settings JS logic and strings. |
| docs/.readthedocs.yaml | Adds post-checkout job steps (unshallow + conditional PR build cancellation). |
Files not reviewed (1)
- docs/.sphinx/_static/bundle.js: Generated file
💡 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 PR supports the migration of MicroOVN docs from https://canonical-microovn.readthedocs-hosted.com/ to https://ubuntu.com/docs/microovn/:
docs/.readthedocs.yamlwith the documentation team's Sphinx Stackdocs/conf.pyto properly render URLs in the built documentation