Versions Compared

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. Operator's Handbook for Cassandra
  4. Improving CQL documentation
  5. Detailed nodetool documentation for operatorsCreate specific how-to guides for use-cases on Cassandra
  6. Get rid of all TODOs on Cassandra Website (docs)Operator's Handbook for Cassandra
  7. Detailed nodetool documentation for operators
  8. Common Application Architecture patterns using CassandraImproving CQL documentation
  9. Document Cassandra Architecture 2.x, 3.x, 3.0.x, 4.x in detail


Project Descriptions

1 - Apache Cassandra 4.0 Documentation Update

...

Many in the community have existing material to cover these topics (including public blog posts, etc) so the most productive approach to completing these sections is likely to be to request good references/material from the mailing lists and synthesise into concise document of the Apache Cassandra documentation set.

Related material:


6 - Common Application Architecture patterns using Cassandra

Project Name: Common Application Architecture patterns using Cassandra

Project Description:

Apache Cassandra is a Distributed Database that is very versatile. It can be applied to various problem domains. If applied correctly, it can scale linearly for the user. This documentation project will document the common architectural patterns that are successfully applied to various domains such as time series data (eg. Financial Stock Data, Weather Data). There are many patterns and best practices that could be documented as part of this project. At a minimum we should try to document the 3 or 4 really common use-cases as well as calling out architectural modifications for various versions of Cassandra. This project can also include situations that will describe integration with other technologies such as Apache Solr, ElasticSearch for search and analytics. The scope is open and can be defined at a later point.


Related material:

7 - Document Cassandra Architecture 2.x, 3.x, 3.0.x, 4.x in detail

Project Name: Document Cassandra Architecture 2.x, 3.x, 3.0.x, 4.x in detail

Project Description:

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

The documentation should describe the overall architecture, relevant classes, differences in various versions of Cassandra, etc.

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


Related material:

...