natas_hw
/
cassandra
mirror of https://github.com/apache/cassandra
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cassandra/doc
History
Patrick McFadin a1fc6c8761 CASSANDRA-21342: Fix broken Antora xref/anchor targets in cassandra docs 
Forward-merge of the Phase 3 A2 fix from trunk (part of commit
32826fe563) to cassandra-4.0. Retargets the ROOT-nav and ROOT-index
Contact us xrefs from the removed master@_:ROOT:contactus.adoc page
to the existing master@_:ROOT:community.adoc.

The fix is applied as a direct edit rather than a cherry-pick: 4.0's
ROOT/nav.adoc has a different surrounding structure from trunk's (no
ifndef::local-build wrapper, no development sub-nav), so a clean
cherry-pick of the trunk patch is not possible. The net effect on
the targeted xrefs is identical.

 patch by Patrick McFadin; reviewed by TBD for CASSANDRA-21342
 		2026-05-14 12:36:21 -07:00
..
cql3 Merge branch cassandra-3.11 into cassandra-4.0 2022-09-28 15:01:46 +02:00
modules CASSANDRA-21342: Fix broken Antora xref/anchor targets in cassandra docs 2026-05-14 12:36:21 -07:00
scripts remove walrus operator in gen-nodetool-docs.py 2023-01-30 15:48:21 -06: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
SASI.md Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +01:00
antora.yml Merge branch 'cassandra-3.11' into cassandra-4.0 2022-01-05 23:00:27 +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 Fix small issues in docs for native protocol v5 2022-05-26 08:28:15 +01: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