Commit Graph

10 Commits

Author SHA1 Message Date
Brandon Williams 6243a1a93c ninja: restore doc/antora.yml 2026-04-16 10:43:25 -05:00
mck 0807210572
Autogenerate the doc antora.yml
patch by Mick Semb Wever; reviewed by Anthony Grasso for CASSANDRA-17375
2026-04-08 15:19:40 +02:00
mck ea79f7b13f
ninja-fix – 5.0 docs are not preview anymore 2025-01-03 11:48:25 +01:00
Lorina Poland 7463a7a977
Vector similarity search docs (CEP-30)
Add example files and partials for reference commands that are added to support vector search.

 patch by Lorina Poland; reviewed by Mick Semb Wever for CASSANDRA-18604
2023-10-31 11:38:41 +01:00
Lorina Poland 3c767b0d6d
SAI docs for CEP-7
patch by Lorina Poland; reviewed by Mick Semb Wever for CASSANDRA-18231
2023-09-26 23:41:19 +02:00
Mick Semb Wever 89fe2223b4
Update trunk to version 5.1
- update jvm-dtest supported upgrade paths
 - update circeci and in-tree scripts to build 5.0 dtest jar
 - update in-tree scripts for better repetitive testing of jvm-dtest-upgrade tests
 - fix jvm-dtest-upgrade tests that broke with 5.0 -> 5.1 upgrades
 - update docs trunk -> 5.0

 patch by Mick Semb Wever; reviewed by Brandon Williams for CASSANDRA-18705
2023-08-14 14:25:19 +02:00
Milan Krisko ea44835bf1
Mark antora.yml in trunk as `prelease:true`
patch by Milan Krisko; reviewed by Mick Semb Wever for CASSANDRA-17823
2022-08-26 12:17:18 +02:00
Mick Semb Wever 54aee87c56
Merge branch 'cassandra-4.0' into trunk 2022-01-05 23:11:36 +01:00
Mick Semb Wever 0aad2e9e86
Merge branch 'cassandra-3.11' into cassandra-4.0 2022-01-05 23:00:27 +01:00
Lorina Poland 05b0eaecad
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>
2022-01-05 22:03:02 +01:00