[CASSANDRA-16761] New Cassandra Website and Documentation

• Type: Epic
• Status: Resolved
• Priority: High
• Resolution: Fixed
• Fix Version/s: NA
• Component/s: Documentation/Website
• Epic Name: New Website and Docs
• Change Category: Code Clarity
• Complexity: Normal
• Platform: All

Source Control Link

See tickets in epic for patch links.

Test and Documentation Plan

N/A. Tickets in epic are already tested and resolved.

• Assignee: Anthony Grasso
• Reporter: Anthony Grasso

Authors

Anthony Grasso

Reviewers

Michael Semb Wever

• Created: 24/Jun/21 20:28
• Updated: 22/Oct/22 02:11
• Resolved: 04/May/22 13:34

Description

This epic captures the work associated with the development of the new Cassandra website and documentation.

Work to create the new website and documentation will be broken up as follows:

• Proof of concept - CASSANDRA-16029
• Website concept and design - CASSANDRA-16115
• Develop tooling to render new website and documentation - CASSANDRA-16066
• Create website content that will be rendered by new tooling - CASSANDRA-16762
• Create Cassandra documentation content that will be rendered by new tooling - CASSANDRA-16763

It is expected that the new website and documentation will be in asciidoc format and rendered using Antora.

Antora is purpose built for rendering versioned documentation to HTML. In addition it allows rendering customisations via Java Script which may be useful when rending the website.

Issue Links

• causes: CASSANDRA-17547 Documentation from Partition Denylist Lost in Document Migration + Minor Fixes
• fixes: CASSANDRA-16481 Add version to website documentation