cc97ee5332
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 #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 Mick Semb Wever for CASSANDRA-21342 |
||
|---|---|---|
| .. | ||
| cql3 | ||
| modules | ||
| scripts | ||
| Makefile | ||
| README.md | ||
| SASI.md | ||
| native_protocol_v3.spec | ||
| native_protocol_v4.spec | ||
| native_protocol_v5.spec | ||
| site-local.yml | ||
README.md
Apache Cassandra documentation directory
This directory contains the documentation maintained in-tree for Apache Cassandra. This directory contains the following documents:
- The source of the official Cassandra documentation, in the
source/modulessubdirectory. See below for more details on how to edit/build that documentation. - The specification(s) for the supported versions of native transport protocol.
Official documentation
The source for the official documentation for Apache Cassandra can be found in the modules/cassandra/pages subdirectory. The documentation uses antora and is thus written in asciidoc.
The antora.yml file is auto-generated and should not be manually edited. It is generated from the version in build.xml using scripts/gen-antora-yml.py and automatically detects whether building from a release tag or branch HEAD to set the appropriate full or short version.
The antora.yml and some of the asciidoc files are dynamically generated using ant gen-asciidoc.
Building HTML Pages
To build the HTML documentation for this version only, you have two options:
Option 1: Using globally installed Antora (requires Node.js, Antora and Pandoc installed):
ant gen-doc
This uses the site-local.yml antora playbook to build only the current in-tree version.
Option 2: Using Docker:
.build/docker/build-docs.sh
This uses the same Docker image as cassandra-website, with all tooling pre-installed.
The HTML will be generated in build/html/.
For building documentation across multiple Cassandra versions, see the build instructions in the cassandra-website repo.
Building Man Pages
Building the html documentation also generates a manpages file.
View the man page:
man ../build/man/cassandra-docs.7.gz
Note: This creates a single comprehensive reference manual (section 7) containing all documentation.