Skip to content

CASSANDRA-21342: Long-tail xref follow-up (trunk)#4810

Open
pmcfadin wants to merge 1 commit into
apache:trunkfrom
pmcfadin:CASSANDRA-21342-trunk-followup
Open

CASSANDRA-21342: Long-tail xref follow-up (trunk)#4810
pmcfadin wants to merge 1 commit into
apache:trunkfrom
pmcfadin:CASSANDRA-21342-trunk-followup

Conversation

@pmcfadin
Copy link
Copy Markdown
Contributor

@pmcfadin pmcfadin commented May 14, 2026

Summary

Follow-up to the umbrella patch for CASSANDRA-21342 (merged 2026-05-14). Closes the long-tail of broken xref errors that remained on trunk after the first wave landed.

Mechanical retargets only — no prose was rewritten and no pages were added or removed. Anchors that did not exist are added with the project's existing [[anchor]] convention.

Edit classes

Class Files Sites
Module-prefix xrefs (bare/partial paths -> cassandra:-qualified) 9 11
Moved-page xrefs (page renamed/relocated; retarget to current home) 9 11
Filename typo (defintions.adoc -> definitions.adoc) 1 1
.html -> .adoc; writetime retargeted to functions.adoc 2 2
nodetool xrefs qualified to cassandra:managing/tools/nodetool/ (generated targets) 3 4
Anchors: add 3 missing [[anchor]] targets and retarget the xrefs that point at them 7 7 + 3 anchor adds

26 files changed total, +40 / -37.

Verification

For every still-existing anchor target, the destination page and explicit [[anchor]] (or auto-generated section id) were grep-verified on upstream/trunk before the edit. Triage was driven by the 2026-04-21 Antora 3 baseline (Jenkins #2752); patterns where no source file on trunk still references the old target were treated as already-closed and not touched.

Build evidence

cassandra-website built locally with Antora 3 against this branch as the cassandra source:

The 3 remaining errors are all in cassandra-website source (two blog posts referencing Cassandra:cassandra:architecture/overview.adoc, and main-nav.adoc referencing Cassandra::index.adoc) — out of scope for this patch on the cassandra repo.

Not included

About ten additional broken xrefs require content decisions and are deferred to a separate workstream alongside the master@_:ROOT:bugs.adoc / contactus.adoc decision (Accord index stub, compression-options retarget, _2i-* partial-prefix resolution, the cyclist_*-table.adoc example references, drop-materialized-view stub, the _/download.adoc cross-component xref). They are mechanically distinct: they need either a new page, an external link, or a prose rewrite — not a retarget.

Generated-page caveat

The four nodetool xrefs included point at generated pages that gen-asciidoc emits at Antora build time, so they cannot be grep-verified from a static checkout. The form matches existing nav.adoc xrefs (e.g. cassandra:managing/tools/nodetool/nodetool.adoc) that have shipped without complaint. If any do not resolve at the next build, will fix in a follow-up.

Forward-merge

cassandra-5.0, cassandra-4.1, and cassandra-4.0 will receive applicable subsets after merge here, following the same convention as the previous CASSANDRA-21342 PR's forward-merges (committer push, no per-branch PR). Pattern-presence will be re-checked per branch.

AI disclosure

Drafting and triage were performed with AI assistance (Anthropic Claude). The change set is reviewable as straightforward xref retargets and anchor additions. Source provenance per ASF generative tooling guidance.

Follow-up to the umbrella patch for CASSANDRA-21342 (merged 2026-05-14).
Closes the long-tail of trunk xref errors that remained after the first
wave landed.

Mechanical retargets only; no prose was rewritten and no pages were
added or removed. Anchors that did not exist are added with the
project's existing [[anchor]] convention.

Edit classes:
* Module-prefix xrefs: bare/partial paths -> cassandra:-qualified
* Moved-page xrefs: retarget to current home on trunk
* Filename typo: defintions.adoc -> definitions.adoc
* Extension: .html -> .adoc; writetime retargeted to functions.adoc
* nodetool xrefs: qualify to cassandra:managing/tools/nodetool/
* Anchors: add three missing [[anchor]] targets and retarget the
  xrefs that point at them

For every still-existing anchor target the destination page and
[[anchor]] (or generated section id) were grep-verified on
upstream/trunk before the edit. Triage was driven by the 2026-04-21
Antora 3 baseline (Jenkins apache#2752); patterns where no source file on
trunk still references the old target were treated as already-closed
and not touched.

Build verification: cassandra-website built locally with Antora 3
against this branch as the cassandra source drops trunk-level errors
from 161 (baseline) to 3. The three remaining errors are all in
cassandra-website source (blog posts + main-nav.adoc) and out of
scope for this patch.

Drafting and triage were performed with AI assistance (Anthropic
Claude); the change set is reviewable as mechanical xref retargets
and anchor additions. Source provenance per ASF generative tooling
guidance.

 patch by Patrick McFadin; reviewed by TBD for CASSANDRA-21342
@pmcfadin pmcfadin force-pushed the CASSANDRA-21342-trunk-followup branch from cac55a5 to dc1186b Compare May 29, 2026 20:17
@pmcfadin pmcfadin marked this pull request as ready for review May 29, 2026 20:27
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.

1 participant