Skip to content

docs: generate <link rel="canonical"> for tagged releases - #4855

Open
lidavidm wants to merge 2 commits into
apache:mainfrom
lidavidm:link-canonical
Open

lidavidm wants to merge 2 commits into
apache:mainfrom
lidavidm:link-canonical

Conversation

@lidavidm

@lidavidm lidavidm commented Oct 5, 2026

Copy link
Copy Markdown
Member

This will only fix things going forward, and we'll eventually want some tool to correct past releases (possibly on an ongoing basis, e.g. because a page may stop existing and we'll want to point to the last version of the page or the replacement page as canonical instead).

Closes #4854.

This will only fix things going forward, and we'll eventually
want some tool to correct past releases (possibly on an ongoing
basis, e.g. because a page may stop existing and we'll want
to point to the last version of the page or the replacement page
as canonical instead).

Closes apache#4854.
@lidavidm
lidavidm requested review from amoeba and a balanced review from Copilot October 5, 2026 07:19

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The tagged build command is invalid, and non-Sphinx API documentation remains without canonical links.

Review effort: Balanced
Findings: 1 High severity · 1 Medium severity

Open (2)
What changed in this PR

Adds canonical URLs for documentation generated from tagged releases.

Changes:

  • Configures Sphinx canonical URLs through ADBC_BASEURL.
  • Sets the canonical base URL for release-tag workflow builds.
File Description
docs/​source/​conf.py Enables Sphinx canonical-link generation.
.github/​workflows/​nightly-website.yml Selects canonical URLs for tagged releases.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/nightly-website.yml Outdated
Comment thread docs/source/conf.py
@lidavidm
lidavidm marked this pull request as ready for review October 5, 2026 07:42
@lidavidm
lidavidm requested a review from zeroshade as a code owner October 5, 2026 07:42

This branch has not been deployed

No deployments
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.

docs: configure rel=canonical for newly generated docs

2 participants