Skip to content

docs: move docs to canonical.com/juju/docs/charmlibs#515

Open
dwilding wants to merge 8 commits into
mainfrom
dotcom-migration
Open

docs: move docs to canonical.com/juju/docs/charmlibs#515
dwilding wants to merge 8 commits into
mainfrom
dotcom-migration

Conversation

@dwilding

@dwilding dwilding commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

This PR updates our doc config so that all URLs use canonical.com/juju/docs/charmlibs instead 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 main and redirect the existing docs.

Main changes

  • Updated Charmlibs doc URLs in .docs/conf.py.
  • Updated hardcoded URLs for Charmlibs, excluding libs that aren't maintained by Charm Tech.
  • Added a script .docs/.sphinx/_static/overwrite_links.js, which is not strictly needed at the moment. This script makes sure that the version switcher from Read the Docs has correct URLs - but we don't use the version switcher. I'm including the script because it's a standard part of the new docs setup at Canonical.

Extra changes

  • Updated the intersphinx URL and hardcoded URLs for Ops. To account for operator#2545
  • Updated the hardcoded URLs for Jubilant. To account for jubilant#337.
  • Updated the hardcoded URLs for Pebble. To account for pebble#882.

Future work (not in this PR)

  • Update hardcoded URLs for Charmlibs in libs that aren't maintained by Charm Tech (one PR per team).
  • Update URLs for other docs - Juju and Charmcraft.

@dwilding dwilding force-pushed the dotcom-migration branch from 042d691 to ea40af4 Compare June 9, 2026 03:54
@dwilding dwilding marked this pull request as ready for review June 9, 2026 04:06
@dwilding dwilding requested a review from a team as a code owner June 9, 2026 04:06

@james-garner-canonical james-garner-canonical left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks, the changes all look reasonable. Will leave it up to you to merge this when ready.

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.

2 participants