Versions Compared

Key

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

...

Please feel free to add project ideas below.

  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. 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 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. This could theoretically cover also some core schema design principles and best practices how to design tables in order to achieve best performance and usability.

Related material:

...

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. I would be very nice to have not only "how" but also "why" behind these commands. Operator should know what each command is for and in what circumstances one should consider to use them. There could be a classification or categorisation of related commands to some groups which are covering some part of Cassandra architecture (eg. commands grouping SSTables and so on). There could be some frequent scenarios and workflows using nodetool command to identify, debug and resolve issues with Cassandra cluster when it comes to every-day usage.

Related material:

...