# Apache Cassandra project This page contains the details of a technical writing project accepted for Google Season of Docs. ## Project summary Open source organization: : Apache Cassandra Technical writer: : dvohra Project name: : Apache Cassandra 4.0 Documentation Update, and Resolve TODOs in Documentation Project length: : Long running (5 months) ## Project description Project consists of two sub-projects as follows: ### 1. Apache Cassandra 4.0 Documentation Update 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 to first put out a call to the cassandra-dev mailing list for Cassandra contributors to highlight areas of the document 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 () with the configuration options actually contained in the source (). ### 2. Resolve TODOs in Apache Cassandra Documentation 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 members of the community have produced material to cover these topics (including public blog posts, Stack Overflow posts, etc). The most productive approach to completing these sections may be to request good references and material from the mailing lists and synthesize into a concise document of the Apache Cassandra documentation set.