History

Brandon Williams 7cbf59e9a1 Merge branch 'cassandra-4.0' into cassandra-4.1		2024-04-03 16:50:43 -05:00
..
cql3	Merge branch cassandra-4.0 into cassandra-4.1	2022-09-28 15:55:23 +02:00
modules	Merge branch 'cassandra-4.0' into cassandra-4.1	2024-04-03 16:50:43 -05:00
scripts	remove walrus operator in gen-nodetool-docs.py	2023-01-30 15:48:21 -06:00
Makefile	Migrate documentation to AsciiDoc	2022-01-05 22:03:02 +01:00
README.md	Migrate documentation to AsciiDoc	2022-01-05 22:03:02 +01:00
SASI.md	Migrate documentation to AsciiDoc	2022-01-05 22:03:02 +01:00
antora.yml	Merge branch 'cassandra-4.0' into cassandra-4.1	2022-08-16 21:48:01 +02:00
native_protocol_v3.spec	Merge branch 'cassandra-3.0' into cassandra-3.11	2021-04-19 17:34:05 +02:00
native_protocol_v4.spec	Transfer parameters to the newly introduced configuration framework (6)	2022-02-05 22:28:40 -05:00
native_protocol_v5.spec	Merge branch 'cassandra-4.0' into cassandra-4.1	2022-05-26 08:33:06 +01:00

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