docs: move docs to canonical.com/juju/docs/ops#2545
Open
dwilding wants to merge 6 commits into
Open
Conversation
This was referenced Jun 5, 2026
dwilding
force-pushed
the
dotcom-migration
branch
from
c33a5fa to
63e1289
Compare
dwilding
force-pushed
the
dotcom-migration
branch
from
63e1289 to
9fece79
Compare
tromai
approved these changes
Jun 18, 2026
Contributor
There was a problem hiding this comment.
Thank you for this change.
I saw in the PR description the link to the Preview docs is Ah nevermind, I saw you mentioned switching back to https://canonical.com/juju/docs/ops/latest/. Does this mean we have publish the docs built from this branch to the new home?main after this PR is merged.
| @@ -0,0 +1,28 @@ | |||
| // Our docs are proxied through to canonical.com/juju/docs/ops. | |||
Contributor
There was a problem hiding this comment.
Should we have a copyright notice for this file?
Contributor
There was a problem hiding this comment.
As this script is a new Canonical docs standard, I assume that it has been battle-tested upstream. But please let me know if I need to have a closer look 😄.
I had a scan through and it looks good to me.
| warnings.warn( | ||
| 'Harness is deprecated. For the recommended approach, see: ' | ||
| 'https://documentation.ubuntu.com/ops/latest/howto/write-unit-tests-for-a-charm/', | ||
| 'https://canonical.com/juju/docs/opslatest/howto/write-unit-tests-for-a-charm/', |
Contributor
There was a problem hiding this comment.
Suggested change
| 'https://canonical.com/juju/docs/opslatest/howto/write-unit-tests-for-a-charm/', | |
| 'https://canonical.com/juju/docs/ops/latest/howto/write-unit-tests-for-a-charm/', |
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
2 participants
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 updates our doc config so that all URLs use
canonical.com/juju/docs/opsinstead of the backend URL from Read the Docs. Our docs are still hosted on Read the Docs, but we'll be proxying them under canonical.com/juju/docs.Preview docs built from this branch. After this PR merges, I'll switch those docs to build from
mainand redirect the existing docs.Main changes
docs/conf.py.CHANGES.md.docs/_static/overwrite_links.js. This script makes sure that the version switcher from Read the Docs has correct URLs. It's a standard part of the new docs setup at Canonical.Extra changes
Future work (not in this PR)