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 7ac5d93c8b CASSANDRA-21342: Retarget commands-toc.adoc xrefs to consolidated CQL anchors 
Follow-up to the trunk PR #4807 forward-merge for cassandra-5.0. The
trunk R1 commit (8e0700a7cb on the chain leading to 32826fe563)
rewrote reference/cql-commands/commands-toc.adoc to retarget 38
broken xref:reference/cql-commands/<page>.adoc[...] entries to the
corresponding anchors in developing/cql/{ddl,dml,functions,mvs,
security,types}.adoc, kept 6 entries that still resolve under
cassandra:reference/cql-commands/, and dropped 4 DSE-only entries
(RESTRICT, RESTRICT ROWS, UNRESTRICT, UNRESTRICT ROWS).

The same transformation is applied here to cassandra-5.0. The trunk
commit was not cherry-pickable because 5.0's commands-toc.adoc had
diverged from trunk's pre-R1 version by ~9 lines (the DSE-only
entries plus an unrelated formatting drift); a direct edit replacing
the file with trunk's post-R1 content was the cleanest application.

One trunk-only entry is omitted: LIST SUPERUSERS (target
developing/cql/security.adoc#list-superusers-statement). That anchor
does not exist on cassandra-5.0; the LIST SUPERUSERS command was
added after 5.0.

All 29 retarget anchors plus the 6 cassandra:reference/cql-commands/
target pages verified to exist on upstream/cassandra-5.0.

 patch by Patrick McFadin; reviewed by TBD for CASSANDRA-21342
 		2026-05-14 14:13:06 -07:00
..
cql3 Minor adds and fixes in the documentation 2024-02-16 12:29:37 +01:00
modules CASSANDRA-21342: Retarget commands-toc.adoc xrefs to consolidated CQL anchors 2026-05-14 14:13:06 -07:00
scripts Autogenerate the doc antora.yml 2026-04-08 15:19:40 +02:00
Makefile Autogenerate the doc antora.yml 2026-04-08 15:19:40 +02:00
README.md Autogenerate the doc antora.yml 2026-04-08 15:19:40 +02:00
SASI.md Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +01:00
native_protocol_v3.spec Autogenerate Native protocol specifications documentation 2025-02-24 21:05:24 +01: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 Autogenerate Native protocol specifications documentation 2025-02-24 21:05:24 +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.

The antora.yml file is auto-generated and should not be manually edited. It is generated from the version in build.xml using scripts/gen-antora-yml.py and automatically detects whether building from a release tag or branch HEAD to set the appropriate version.

To generate the asciidoc files (including antora.yml) 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