Google Git
Sign in
apache / cassandra / eb5eda76c5b3110bb86b687da64bb99965af0fbb / . / doc
tree: 3d8f5bd419eaa8e6340f194d76bee2fce5da0a22 [path history] [tgz]
  1. cql3/
  2. modules/
  3. scripts/
  4. antora.yml
  5. Makefile
  6. native_protocol_v3.spec
  7. native_protocol_v4.spec
  8. native_protocol_v5.spec
  9. README.md
doc/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