Skip to content

docs: update links and config for switch to documentation.ubuntu.com/ops#1940

Merged
dwilding merged 4 commits intocanonical:mainfrom
dwilding:move-docs-latest
Jul 31, 2025
Merged

docs: update links and config for switch to documentation.ubuntu.com/ops#1940
dwilding merged 4 commits intocanonical:mainfrom
dwilding:move-docs-latest

Conversation

@dwilding
Copy link
Contributor

@dwilding dwilding commented Jul 31, 2025

This PR changes all hardcoded doc links to point to https://documentation.ubuntu.com/ops/latest/ instead of https://ops.readthedocs.io/en/latest/. In addition to switching to documentation.ubuntu.com, we're dropping en from URLs.

This PR also changes the Sphinx config to make sure that all styles can be loaded.


Related PR targeted at 2.23-maintenance: #1942. As soon as both PRs have merged, I'll set up redirects from ops.readthedocs.io to documentation.ubuntu.com/ops.

@dwilding
Copy link
Contributor Author

@benhoyt & @tonyandrewmeyer would you mind reviewing this PR and #1942 if possible? Thanks! I think it would be good to review both PRs at the same time if possible, as you'll get a better sense of what I left out of #1492. Please let me know if you think #1492 should expand in scope to essentially match this PR.

Copy link
Collaborator

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - a couple of small questions/comments, but happy to approve.

I haven't actually tested this in any way; I assume I can't really do that.

@dwilding dwilding merged commit 625a6bf into canonical:main Jul 31, 2025
44 checks passed
@dwilding dwilding deleted the move-docs-latest branch July 31, 2025 23:56
dwilding added a commit that referenced this pull request Jul 31, 2025
…buntu.com/ops (#1942)

This PR changes _selected_ hardcoded doc links to point to
https://documentation.ubuntu.com/ops/2.23/ or
https://documentation.ubuntu.com/ops/latest/ (as appropriate) instead of
https://ops.readthedocs.io/en/latest/.

Since the changes are targeted at 2.23-maintenance, I wanted to avoid
unnecessary doc and code changes. So I'm only adjusting the links that
people would first encounter in the README/PyPI/docs.

This PR also changes the Sphinx config to make sure that all styles can
be loaded.

---

Related PR targeted at main:
#1940. As soon as both PRs
have merged, I'll set up redirects from ops.readthedocs.io to
documentation.ubuntu.com/ops.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants