2aa2b59d37899fbe114bdd75e09c10699729c32a | Author: Lorina Poland <lorina@datastax.com>
| 2024-01-08 12:46:02-08:00
Minor adds and fixes in the documentation
patch by Lorina Poland; reviewed by Michael Semb Wever for CASSANDRA-19249, CASSANDRA-18990, CASSANDRA-15719
Co-authored-by: Annette Dennis <annette.dennis@datastax.com>
Co-authored-by: Mohsin Medmood <mohsin85mehmood@gmail.com>
Co-authored-by: Josh Wong <joshuarwong@outlook.com>
05b0eaecad5e40390352a4e182179a29ac784372 | Author: Lorina Poland <lorinapoland@gmail.com>
| 2021-06-28 10:19:46-07:00
Migrate documentation to AsciiDoc
This commit sets up a new documentation structure and format:
* The directory struture changes from a Sphinx project to an Antora module layout.
* The formatting of the content changes from reStructuredText to AsciiDoc.
The documentation must now be built and published with Antora. Initially only from the cassandra-website repository.
This change was done to make maintaining versioned website documentation easier. As Antora is designed to generate versioned documentation.
The old directory structure was:
<ROOT>
- doc/
- cql3/
- CQL.css
- CQL.textile
- source/
- _static/
- _templates/
- _theme/
- _util/
- <other directory sections>/
- conf.py
- index.rst
- <other *.rst pages>
- make.bat
- Makefile
- README.md
- SASI.md
- <*.spec files>
- <generation scripts>
The new directory structure organises the documentation into modules:
<ROOT>
- doc/
- cql3
- modules/
- cassandra/
- assets/
- examples/
- pages/
- partials/
- nav.adoc
- ROOT/
- pages/
- nav.adoc
- scripts/
- antora.yaml
- README.md
- SASI.md
patch by Lorina Poland, Anthony Grasso; reviewed by Anthony Grasso, Mick Semb Wever for CASSANDRA-16763
Co-authored-by: Anthony Grasso <anthony@thelastpickle.com>