natas_hw
/
cassandra
mirror of https://github.com/apache/cassandra
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cassandra/doc
History
Andrés de la Peña 410018ab16 Fix spelling errors in the documentation for DDM 
patch by Andrés de la Peña; reviewed by Brandon Williams for CASSANDRA-18790

Co-authored-by: Andrés de la Peña <a.penya.garcia@gmail.com>
Co-authored-by: Lorina Poland <lorinapoland@gmail.com>
 		2023-08-24 11:22:45 +01:00
..
cql3 CIDR filtering authorizer 2023-07-28 20:10:02 -07:00
modules Fix spelling errors in the documentation for DDM 2023-08-24 11:22:45 +01:00
scripts Docs: Revise and fix leftnav and links 2023-08-23 14:34:03 -07: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 Update trunk to version 5.1 2023-08-14 14:25:19 +02: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