[CASSANDRA-16763] Create Cassandra documentation content for new website

• Type: Task
• Status: Resolved
• Priority: High
• Resolution: Fixed
• Fix Version/s: 3.11.12, 4.0.2, 4.1-alpha1, 4.1
• Component/s: Documentation/Website
• Labels: pull-request-available
• Epic Link: New Website and Docs
• Change Category: Operability
• Complexity: Normal
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/05b0eaecad5e40390352a4e182179a29ac784372

Test and Documentation Plan

The Cassandra documentation can be rendered using the tooling in the cassandra-website repository. The steps to do this are as follows.

 

Step 1. Set up the cassandra-website tooling

Clone the cassandra-website to your local machine by running the following command.

$ git clone https://github.com/apache/cassandra-website.git

Build the ui-bundle.zip to style the documentation by running the following command.

$ ./run.sh website-ui bundle 

The ui-bundle.zip file will be located in site-ui/build/

 

Step 2. Render the documentation

Render the website and documentation HTML for the latest three branches of Cassandra using the following command.

$ ./run.sh website build \
    -i
    -z site-ui/build/ui-bundle.zip \
    -u cassandra:https://github.com/polandll/cassandra.git

The rendered HTML will be located in site-content/build/html/

To view the documentation open a browser and navigate to file:///<path_to_cassandra_website>/site-content/build/html/Cassandra/

• Assignee: Michael Semb Wever
• Reporter: Anthony Grasso

Authors

Michael Semb Wever

Reviewers

Michael Semb Wever

• Created: 24/Jun/21 20:40
• Updated: 02/Jul/22 10:34
• Resolved: 05/Jan/22 23:23

Description

We need create the content (asciidoc) to render the Cassandra documentation using Antora. This work can commence once the following has happened:

• Website and documentation proof of concept is done - CASSANDRA-16029
• Website design and concept is done - CASSANDRA-16115
• Website and document tooling is done - CASSANDRA-16066 
• Website UI components are done - CASSANDRA-16762

Issue Links

• causes: CASSANDRA-17727 Remove read_repair table option from <4.0 docs, and restore read_repair_chance docs
• links to: GitHub Pull Request #85