docs: migrate URL#561
Merged
Merged
Conversation
Thanhphan1147
approved these changes
Jun 23, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Migrates HAProxy charm documentation references from Read the Docs/Ubuntu domains to the Canonical domain, and updates Sphinx configuration/assets to publish with the new canonical URL.
Changes:
- Updated multiple
charmcraft.yamlfiles to pointlinks.documentationtohttps://canonical.com/juju/docs/haproxy-charm/. - Updated Sphinx config (
docs/conf.py) to use Canonical-domain base URLs and load a new JS file. - Added a small JS helper to rewrite old RTD-domain links in rendered docs; refresh README + changelog entry.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| haproxy-spoe-auth-operator/charmcraft.yaml | Points charm metadata documentation link to Canonical domain |
| haproxy-route-policy-operator/charmcraft.yaml | Points charm metadata documentation link to Canonical domain |
| haproxy-operator/charmcraft.yaml | Points charm metadata documentation link to Canonical domain |
| haproxy-ddos-protection-configurator/charmcraft.yaml | Updates documentation link target (but currently retains questionable YAML structure) |
| docs/conf.py | Sets canonical/base URLs for Sphinx outputs and includes new JS asset |
| docs/changelog.md | Adds changelog entry for the migration |
| docs/_static/js/overwrite_links.js | New script to rewrite old-domain links in rendered docs |
| README.md | Updates documentation location and link |
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.
What this PR does
This PR migrates the RTD documentation under the Canonical domain.
Why we need it
URL migrations are a high priority this cycle that we need to complete ASAP.
Checklist
docs/changelog.mdwith user-relevant changesdocs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the labelno-release-note.(e.g., in
.github/workflows/integration_tests.yaml, ensure themoduleslist is correct)terraform fmtpasses andtflintreports no errors