Versions Compared

Old Version 13

changes.mady.by.user Dinesh Joshi

Saved on

compared with

New Version 14

changes.mady.by.user Aaron Ploetz

Saved on

Key

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

...

Project Description: Review and update existing Apache Cassandra documentation to ensure that it is aligned with the forthcoming Apache Cassandra 4.0 release. Our proposed approach to this would be firstly, to first put out a call to the cassandra-dev mailing list for Cassandra contributors to highlight areas of the document that require update and secondly, which are in need of updates. Secondly, we would put together a structured review of the existing documentation to identify potential 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 the source (https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).

...

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 would cover topics right from Installation to Tuning & Troubleshooting the database. Here There are the several top level topics which we 'd would like to cover –, including but not limited to:

  1. Installation
  2. Configuring
  3. Securing
  4. Monitoring
  5. Tuning
  6. Safely restartrestarting
  7. Adding, removing, & replacing nodes
  8. Upgrading Cassandra
  9. Backing up & Restoring
  10. ExpansionsExpanding, Shrinking shrinking & Replacingreplacing
  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 There may be additional topics that might get to be added later. The This handbook will would also cover various prior versions of Cassandra such as (2.x, 3.x, 3.11.x, 4.x pointing out etc) highlighting the differences between the versionsthem. We estimate that each topic might take anywhere between somewhere around 1-5 pages to cover the topic. The project will also include adding sample code, commands and illustrations.

Note: The scope of this project is undoubtedly large. We will work with you, the technical writer, to scope ensure that it is scoped appropriately after discussing it with you.


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. Similarly, CQL provides syntactic structures such as DDL (Data Definition Language), DML (Data Modification Language) & and DCL (Data Control Language). CQL also has a well defined grammar and syntax which varies may vary with the Cassandra version. This While Apache Cassandra 4.0 will be the newest version, the documentation should also provide support for the earlier versions of Cassandra 2.x, 3.x, and 3.11.x, 4. x. There are approximately 40 CQL commands, with several options in available for each. The document should contain example usages for each CQL command, as well as how it its use varies amongst the different versions. This could theoretically cover also some core schema design principles and best practices, as well as how to design tables in order to achieve the best optimal performance and usability.

...


4 - Detailed

...

Nodetool Documentation for

...

Operators

Project Name: Apache Cassandra nodetool documentation Nodetool Documentation for operatorsOperators

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 command line tool that operators rely heavily on which Cassandra operators will often use for their day-to-day operations. It is one of the mechanisms that by which an operator interacts with a node in the cluster. Therefore, it is a critical aspect of building & and 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 available for each. The document should also contain example usages examples for each nodetool command, as well as how it varies amongst the different versions. It would be very nice to have not only the "how" behind a particular command, but also "why" behind these commands would be used. Operator The operator should know what each command is for and in what under which 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 onIt may be useful for the commands to be grouped by category (ex: commands for grouping SSTables, et al). There could also be some definition around frequent scenarios and workflows shown to highlight using various nodetool command commands to identify, debug and resolve issues with within a Cassandra cluster when it comes to , in terms of every-day usage.

Related material:

...

Apache Cassandra is a Distributed Database that is very versatile. There are various stable versions of the database that are available. This documentation project will try and produce detailed documentation of Cassandra's internal architecture for all stable versions. This is critical for new developers as well as operators to understand how the database functions under the hood. This will also help new developers get a better understanding of the internals there by making contributions easier and better quality. There are various aspects that we will cover here including, but not limited to -:

  1. General Cassandra Architecture
  2. Code organization
  3. Storage Engine
  4. Internode Communication
  5. Native Protocol
  6. Secondary Indexes
  7. Materialized Views
  8. Gossip

...