Versions Compared

Old Version 4

changes.mady.by.user Dinesh Joshi

Saved on

compared with

New Version 5

changes.mady.by.user Ben Slater

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Update Cassandra documentation for 4.0 release
  2. Document Cassandra Architecture 2.x, 3.x, 3.0.x, 4.x in detail
  3. Create specific how-to guides for use-cases on Cassandra
  4. Get rid of all TODOs on Cassandra Website (docs)
  5. Operator's Handbook for Cassandra
    1. Install Cassandra
    2. Safely restart
    3. Adding, removing, replacing nodes
    4. Upgrading Cassandra
    5. Backing up & Restoring
    6. Expansions, Shrinking & Replacing
    7. Tuning Cassandra
  6. Detailed nodetool documentation for operators
  7. Common Application Architecture patterns using Cassandra
  8. Improving CQL documentation


Project Descriptions

1 - Apache Cassandra 4.0 Documentation Update

Project Name: Apache Cassandra 4.0 Documentation Update

Project Description: Review and update existing Apache Cassandra documentation to ensure it is aligned with the forthcoming Apache Cassandra 4.0 release. Our proposed approach to this would be firstly, a call to the cassandra-dev mailing list for Cassandra contributors to highlight areas of the document that require update and secondly, a structured review of existing documentation to identify gaps. For example, in the structured review, the technical writer could compare the Cassandra configuration file documentation (http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html) with the configuration options actually contained in code (https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).

Related material: