...
There may be additional topics to be added later. This handbook would also cover prior versions of Cassandra (2.x, 3.x, 3.11.x, etc) highlighting the differences between them. We estimate that each topic might take somewhere around 1-5 pages to cover the topic. The project will also include adding sample code, commands and illustrations.
Note: The The scope of this project is undoubtedly large. We will work with you, the technical writer, to ensure that it is scoped appropriately.
...
Project Description: The Apache Cassandra documentation contains a number of sections highlighted as "TODO" (or tasks yet to be completed). These are:
- Operating Cassandra / Backups
- Operating Cassandra / Bulk Loading
- CQL / Data Definitions (limited review points)
- Data Modelling
- Dynamo / Gossip, Failure Detection and Token Ring
- Architecture/Guarantees
- Operating Cassandra/Hints
- Architecture/Overview (this is proposed as a separate project)
- Operating Cassandra/Read Repair
Many in members of the community have existing produced material to cover these topics (including public blog posts, Stack Overflow posts, etc) so the . The most productive approach to completing these sections is likely to may be to request good references /nd material from the mailing lists and synthesise into synthesize into a concise document of the Apache Cassandra documentation set.
...
Apache Cassandra is a Distributed Database that which is very versatile . It and can be applied to various problem domains. If applied correctly, it can scale linearly for the user. This documentation project will document define the common architectural patterns that which are successfully applied to various domains, such as time series data (eg. ex: Financial Stock Data, Weather Data) and query-based data models. There are many patterns and best practices that which could be documented as a part of this project. At a minimum, we should try to document the 3 or 4 really most common use-cases, as well as calling out architectural modifications for the various versions of Cassandra. This project can also include situations that will describe use cases around integration with other technologies such as tools like Apache Solr , and ElasticSearch (for search and analytics). The scope is open and can be defined at a later point.
...
Apache Cassandra is a Distributed Database that which is very versatile. There are various stable versions of the database that which are available for use. This documentation project will try and to produce detailed documentation of Cassandra's internal architecture for all stable versions. This is critical for new developers, as well as experienced operators to understand how the database functions "under the hood." This will also help new developers get gain a better understanding of the internals there by making contributions easier and better quality, thereby improving the ease and quality of their contributions. There are various aspects that we will cover which can be covered here including, but not limited to:
- General Cassandra Architecture
- Code organizationOganization
- Storage Engine
- Internode Communication
- Native Protocol
- Secondary Indexes
- Materialized Views
- Gossip
The documentation should describe the overall architecture, relevant classes, and differences in the various versions of Cassandra, etc.
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:
- Existing published documentation: http://cassandra.apache.org/doc/latest/
- Documentation source (RST format): https://github.com/apache/cassandra/tree/trunk/doc
- Project source: https://github.com/apache/cassandra
- Developer mailing list archive: https://lists.apache.org/list.html?dev@cassandra.apache.org
- User mailing list archive: https://lists.apache.org/list.html?user@cassandra.apache.org
...