Skip to content

docs: migrate URL#561

Merged
erinecon merged 9 commits into
mainfrom
migrate-latest
Jun 23, 2026
Merged

docs: migrate URL#561
erinecon merged 9 commits into
mainfrom
migrate-latest

Conversation

@erinecon

Copy link
Copy Markdown
Contributor

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

  • I followed the contributing guide
  • I added or updated the documentation (if applicable)
  • I updated docs/changelog.md with user-relevant changes
  • I added a change artifact for user-relevant changes in docs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the label no-release-note.
  • I used AI to assist with preparing this PR
  • [N/A] I added or updated tests as needed (unit and integration)
  • [N/A] If integration test modules are used: I updated the workflow configuration
    (e.g., in .github/workflows/integration_tests.yaml, ensure the modules list is correct)
  • [N/A] If this PR involves Terraform: terraform fmt passes and tflint reports no errors
  • [N/A] If this PR involves Rockcraft: I updated the version

@erinecon erinecon added documentation Improvements or additions to documentation no-release-note This PR does not require a change artifact labels Jun 18, 2026
@erinecon erinecon marked this pull request as ready for review June 22, 2026 15:51
@erinecon erinecon requested a review from a team as a code owner June 22, 2026 15:51
@Thanhphan1147 Thanhphan1147 requested a review from Copilot June 23, 2026 02:37
Comment thread docs/_static/js/overwrite_links.js

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.yaml files to point links.documentation to https://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

Comment thread haproxy-ddos-protection-configurator/charmcraft.yaml Outdated
Comment thread docs/conf.py
Comment thread docs/conf.py
Comment thread docs/conf.py
Comment thread docs/_static/js/overwrite_links.js
Comment thread docs/changelog.md
@erinecon erinecon merged commit 6b414b9 into main Jun 23, 2026
99 checks passed
@erinecon erinecon deleted the migrate-latest branch June 23, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Libraries: Out of sync no-release-note This PR does not require a change artifact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants