History

Bernardo Botella Corbi e5f99c5cc5 CASSANDRA-20699 Fix SAI virtual table names in documentation patch by Soheil Rahsaz; reviewed by Bernardo Botella and Caleb Rackliffe for CASSANDRA-20699		2025-06-16 15:50:52 +02:00
..
cql3	…
modules	CASSANDRA-20699 Fix SAI virtual table names in documentation	2025-06-16 15:50:52 +02:00
scripts	Merge branch 'cassandra-5.0' into trunk	2025-05-26 14:41:16 +02:00
Makefile	…
README.md	…
SASI.md	…
antora.yml	…
native_protocol_v3.spec	…
native_protocol_v4.spec	…
native_protocol_v5.spec	…

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/modules subdirectory. 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.

To generate the asciidoc files for cassandra.yaml and the nodetool commands, run (from project root):

ant gen-asciidoc

or (from this directory):

make gen-asciidoc

(The following has not yet been implemented, for now see the build instructions in the cassandra-website repo.) To build the documentation, run (from project root):

ant gen-doc

or (from this directory):

make html