cassandra/doc
Stefan Miklosovic 98ec8970e1
Move training parameters for Zstd dictionary compression to CQL
It is also possible to override them via nodetool if necessary.

This patch also fixes the computation of sampling ratio to not lose the precision.

patch by Stefan Miklosovic; reviewed by Jyothsna Konisha, Yifan Cai for CASSANDRA-21078
2026-01-07 16:21:47 +01:00
..
cql3 Implementation of CEP-55 - Generation of role names 2025-10-23 13:53:56 +02:00
modules Move training parameters for Zstd dictionary compression to CQL 2026-01-07 16:21:47 +01:00
scripts Implementation of CEP-55 - Generation of role names 2025-10-23 13:53:56 +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