cassandra/doc
Himanshu Jindal daef7b5b98 Safeguard Full repair against disk protection
As per CASSANDRA-20045, we want to prevent full repair against
disk full scenarios. Current protection exists only for incremental
repair. This change updates the config name to not be
incremental repair specific, using the Replace annotation.

patch by Himanshu Jindal; reviewed by David Capwell, Jaydeepkumar Chovatia for CASSANDRA-20045
2025-08-22 14:34:15 -07:00
..
cql3 Support manual secondary index selection at the CQL level 2025-08-01 14:42:27 -05:00
modules Safeguard Full repair against disk protection 2025-08-22 14:34:15 -07:00
scripts Merge branch 'cassandra-5.0' into trunk 2025-05-26 14:41:16 +02:00
Makefile Autogenerate Native protocol specifications documentation 2025-02-24 21:05:24 +01:00
README.md Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +01:00
SASI.md CASSANDRA-20117: fixed typos in NTR spec and SASI documents 2025-04-03 13:59:05 -04:00
antora.yml ninja-fix – 5.0 docs are not preview anymore 2025-01-03 11:48:25 +01:00
native_protocol_v3.spec CASSANDRA-20117: fixed typos in NTR spec and SASI documents 2025-04-03 13:59:05 -04:00
native_protocol_v4.spec CASSANDRA-20117: fixed typos in NTR spec and SASI documents 2025-04-03 13:59:05 -04:00
native_protocol_v5.spec CASSANDRA-20117: fixed typos in NTR spec and SASI documents 2025-04-03 13:59:05 -04: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