mirror of https://github.com/apache/cassandra
f27790c969
This patch includes all the changes from the PRs that introduce small changes related to typos and similar in the documentation. The changes are accumulated from the following PRs: - https://github.com/apache/cassandra/pull/206 - https://github.com/apache/cassandra/pull/359 - https://github.com/apache/cassandra/pull/366 - https://github.com/apache/cassandra/pull/390 - https://github.com/apache/cassandra/pull/450 - https://github.com/apache/cassandra/pull/567 - https://github.com/apache/cassandra/pull/615 - https://github.com/apache/cassandra/pull/618 - https://github.com/apache/cassandra/pull/746 - https://github.com/apache/cassandra/pull/984 - https://github.com/apache/cassandra/pull/1052 - https://github.com/apache/cassandra/pull/1088 - https://github.com/apache/cassandra/pull/1274 - https://github.com/apache/cassandra/pull/1378 - https://github.com/apache/cassandra/pull/1404 - https://github.com/apache/cassandra/pull/1504 - https://github.com/apache/cassandra/pull/1540 - https://github.com/apache/cassandra/pull/1544 - https://github.com/apache/cassandra/pull/1673 - https://github.com/apache/cassandra/pull/1697 - https://github.com/apache/cassandra/pull/1722 - https://github.com/apache/cassandra/pull/1815 - https://github.com/apache/cassandra/pull/1830 - https://github.com/apache/cassandra/pull/1863 - https://github.com/apache/cassandra/pull/1865 - https://github.com/apache/cassandra/pull/1879 - https://github.com/apache/cassandra/pull/2062 patch by Nikita Eshkeev, reviewed by Stefan Miklosovic, Lorina Poland, Michael Semb Wever for CASSANDRA-18185 Co-authored-by: kalmant <kalmant@users.noreply.github.com> Co-authored-by: Dmitry <xotonic@yandex.ru> Co-authored-by: Tibor Répási <rtib@users.noreply.github.com> Co-authored-by: Tzach Livyatan <tzach@scylladb.com> Co-authored-by: Jérôme BAROTIN <jeromebarotin@gmail.com> Co-authored-by: Giorgio Giuffrè <giorgiogiuffre23@gmail.com> Co-authored-by: Siddhartha Tiwari <201851127@iiitvadodara.ac.in> Co-authored-by: Angelo Polo <language.devel@gmail.com> Co-authored-by: Tjeu Kayim <15987676+TjeuKayim@users.noreply.github.com> Co-authored-by: 陳傑夫 <chienfuchen32@gmail.com> Co-authored-by: Bhouse99 <bhouse99@protonmail.com> Co-authored-by: Matthew Hardwick <MatthewRHardwick@gmail.com> Co-authored-by: Paul Wouters <paul.wouters@aiven.io> Co-authored-by: Romain Hardouin <romain_hardouin@yahoo.fr> Co-authored-by: Guilherme Poleto <gpoleto@alunos.utfpr.edu.br> Co-authored-by: 陳傑夫 <chienfuchen32@gmail.com> Co-authored-by: etc-crontab <jujut@free.fr> Co-authored-by: Prashant Bhuruk <prashantbhuruk88@gmail.com> Co-authored-by: Jingchuan Zhu <56401528+codingswag998@users.noreply.github.com> Co-authored-by: Ryan Stewart <ryan.stewart@rackspace.com> Co-authored-by: utkarsh-agrawal-jm <107914361+utkarsh-agrawal-jm@users.noreply.github.com> Co-authored-by: Ben Dalling <b.dalling@locp.co.uk> Co-authored-by: Terry L. Blessing <tlblessing1@gmail.com> Co-authored-by: gruzilkin <gruzmob@gmail.com> Co-authored-by: Kevin <kevin.xgr@gmail.com> Co-authored-by: yziadeh <121903189+yziadeh@users.noreply.github.com> Co-authored-by: Lorina Poland <lorina@datastax.com> Co-authored-by: Stefan Miklosovic <smiklosovic@apache.org> |
||
|---|---|---|
| .. | ||
| cql3 | ||
| modules | ||
| scripts | ||
| Makefile | ||
| README.md | ||
| SASI.md | ||
| antora.yml | ||
| native_protocol_v3.spec | ||
| native_protocol_v4.spec | ||
| native_protocol_v5.spec | ||
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/modulessubdirectory. 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