Versions Compared

Old Version 5

changes.mady.by.user Ben Slater

Saved on

compared with

New Version 6

changes.mady.by.user Dinesh Joshi

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
  6. Install Cassandra
  7. Safely restart
  8. Adding, removing, replacing nodes
  9. Upgrading Cassandra
  10. Backing up & Restoring
  11. Expansions, Shrinking & Replacing
  12. Tuning Cassandra
  13. Detailed nodetool documentation for operators
  14. Common Application Architecture patterns using Cassandra
  15. Improving CQL documentation

...

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:

2 - Cassandra Operator's Handbook

Project Name: Apache Cassandra Operational Handbook

Project Description: Apache Cassandra is a distributed database that is seeking a qualified technical writer to create an extensive operator's handbook. This handbook will cover topics right from Installation to Tuning & Troubleshooting the database. Here are the top level topics we'd like to cover –

  1. Installation
  2. Configuring
  3. Securing
  4. Monitoring
  5. Tuning
  6. Safely restart
  7. Adding, removing, replacing nodes
  8. Upgrading Cassandra
  9. Backing up & Restoring
  10. Expansions, Shrinking & Replacing
  11. Troubleshooting Cassandra
  12. Miscellaneous tools & utilities

This is not an exhaustive list of topics. This is just indicative of the topics we'd like to cover. There might be additional topics that might get added later. The handbook will cover various versions of Cassandra such as 2.x, 3.x, 3.11.x, 4.x pointing out differences between the versions. We estimate that each topic might take anywhere between 1-5 pages to cover the topic. The project will also include adding sample code, commands and illustrations.

Related material:


3 - Improving CQL documentation

Project Name: Apache Cassandra CQL Documentation

Project Description: Apache Cassandra is a distributed database that is seeking a qualified technical writer to create documentation for Cassandra's Query Language (CQL). CQL, like SQL, is a query language that allows users to interact with Cassandra. CQL provides DDL (Data Definition Language), DML (Data Modification Language) & DCL (Data Control Language). CQL has a well defined grammar and syntax which varies with the Cassandra version. This documentation should support Cassandra 2.x, 3.x, 3.11.x, 4.x. There are approximately 40 CQL commands with several options in each. The document should contain example usages for each CQL command as well as how it varies amongst different versions.

Related material:


4 - Detailed nodetool documentation for operators

Project Name: Apache Cassandra nodetool documentation for operators

Project Description: Apache Cassandra is a distributed database that is seeking a qualified technical writer to create documentation for Cassandra's nodetool. nodetool is a tool that operators rely heavily on for their day-to-day operations. It is one of the mechanisms that an operator interacts with a node in the cluster. Therefore it is a critical aspect of building & managing a Cassandra cluster. This documentation should support Cassandra 2.x, 3.x, 3.11.x, 4.x. There are approximately 80 nodetool commands with several options in each. The document should contain example usages for each nodetool command as well as how it varies amongst different versions.

Related material:

...