History

Brad Schoening 2a623b6cf3 Fix asciidoc markup in cql_singlefile.adoc patch by Brad Schoening; reviewed by Michael Semb Wever for CASSANDRA-20195		2025-01-25 12:01:30 +01:00
..
cql3	Minor adds and fixes in the documentation	2024-02-16 12:29:37 +01:00
modules	Fix asciidoc markup in cql_singlefile.adoc	2025-01-25 12:01:30 +01:00
scripts	Fix nodetool docs page	2025-01-02 16:07:16 +01:00
Makefile	Docs: Revise and fix leftnav and links	2023-08-23 14:34:03 -07: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	ninja-fix – 5.0 docs are not preview anymore	2025-01-03 11:48:25 +01: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	Added support for type VECTOR<type, dimension>	2023-06-22 08:43:53 -07: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