Skip to content

chore: repath docs sitemap - #5790

Merged
shaloo merged 1 commit into
canonical:mainfrom
medubelko:patch-1
Jul 21, 2026
Merged

chore: repath docs sitemap#5790
shaloo merged 1 commit into
canonical:mainfrom
medubelko:patch-1

Conversation

@medubelko

@medubelko medubelko commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Because the docs don't use a version or language slug, RTD defaults to the sitemap at the site root. There's a bug with RTD where this path is unavailable after our builds, so we need to rename it.

Downstream of canonical/snap-docs#437

Done

How to QA

Testing

  • This PR has tests
  • No testing required (explain why):

Security

  • Security considerations for review (list them):
    • Examples:
    • Access control: users can only access their own data
    • Input: user input is validated and sanitised
    • Sensitive data: secret or private data is not exposed in any way
    • ...
  • This PR has no security considerations (explain why): Change to a publicly-available path on an external service

UX Approval

  • This PR does not require UX approval
  • This PR does require UX approval (add context):

Because the docs don't use a version or language slug, RTD defaults to the sitemap at the site root. There's a bug with RTD where this path is unavailable after our builds, so we need to rename it.
Copilot AI review requested due to automatic review settings July 10, 2026 16:54
@webteam-app

Copy link
Copy Markdown

medubelko is not a collaborator of the repo

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

Updates the site-wide sitemap index to reference a renamed docs sitemap path, intended to work around a Read the Docs sitemap-path issue for docs hosted without version/language slugs.

Changes:

  • Repoints the docs sitemap entry in the sitemap index from /docs/sitemap.xml to /docs/doc-sitemap.xml.

Comment thread templates/sitemap/sitemap-index.xml
Comment thread templates/sitemap/sitemap-index.xml
@shaloo
shaloo merged commit 7d878ea into canonical:main Jul 21, 2026
11 checks passed
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.

5 participants