natas_hw
/
cassandra
mirror of https://github.com/apache/cassandra
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cassandra/doc
History
Erick Ramirez 84f629752f Fixed Configuration index, topologies, CDC archiving properties pages (3.11) 
patch by taku333, Erick Ramirez; reviewed by Erick Ramirez for CASSANDRA-17444

Co-authored by: taku333 <19281989thezuka@gmail.com>
Co-authored by: Erick Ramirez <erickramirezau@apache.org>
 		2022-03-22 11:02:50 +00:00
..
cql3 Merge branch 'cassandra-3.0' into cassandra-3.11 2021-04-19 17:34:05 +02:00
modules Fixed Configuration index, topologies, CDC archiving properties pages (3.11) 2022-03-22 11:02:50 +00:00
scripts Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +01: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
antora.yml Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +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 Merge branch 'cassandra-3.0' into cassandra-3.11 2021-04-19 17:34:05 +02:00
native_protocol_v5.spec Merge branch 'cassandra-3.0' into cassandra-3.11 2021-04-19 17:34:05 +02: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