Apache Cassandra project
Stay organized with collections
Save and categorize content based on your preferences.
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
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
with the configuration options actually contained in the source
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis project focuses on updating the Apache Cassandra documentation to align with the upcoming 4.0 release and addressing outstanding TODOs within the existing documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe project will involve community collaboration to identify areas needing updates and a structured review to ensure comprehensive coverage of features like configuration options.\u003c/p\u003e\n"],["\u003cp\u003eResolving documentation TODOs will entail leveraging existing community resources such as blog posts and Stack Overflow discussions to create concise and informative content.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to enhance the clarity and completeness of Apache Cassandra documentation, benefiting both new and experienced users.\u003c/p\u003e\n"]]],["The project involves two main tasks: updating Apache Cassandra documentation for the 4.0 release and resolving \"TODO\" sections within the existing documentation. The update will be achieved by soliciting feedback from Cassandra contributors and conducting a structured review of existing documentation, including comparing configuration file documentation with source code. Addressing \"TODOs\" will involve gathering community-sourced material from mailing lists and other sources to complete incomplete documentation sections, such as \"Backups\" and \"Data Modeling.\"\n"],null,["This page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n\nOpen source organization:\n: Apache Cassandra\n\nTechnical writer:\n: dvohra\n\nProject name:\n: Apache Cassandra 4.0 Documentation Update, and Resolve TODOs in Documentation\n\nProject length:\n: Long running (5 months)\n\nProject description\n\nProject consists of two sub-projects as follows:\n\n1. Apache Cassandra 4.0 Documentation Update\n\nReview and update existing Apache Cassandra documentation to ensure that it \n\nis aligned with the forthcoming Apache Cassandra 4.0 release. Our proposed \n\napproach to this would be to first put out a call to the cassandra-dev \n\nmailing list for Cassandra contributors to highlight areas of the document \n\nwhich are in need of updates. Secondly, we would put together a structured \n\nreview of the existing documentation to identify potential gaps. For \n\nexample: in the structured review, the technical writer could compare the \n\nCassandra configuration file documentation \n\n(\u003chttp://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html\u003e)\nwith the configuration options actually contained in the source \n\n(\u003chttps://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java\u003e).\n\n2. Resolve TODOs in Apache Cassandra Documentation\n\nThe Apache Cassandra documentation contains a number of sections \n\nhighlighted as \"TODO\" (or tasks yet to be completed). These are:\n\n- Operating Cassandra / Backups\n- Operating Cassandra / Bulk Loading\n- CQL / Data Definitions (limited review points)\n- Data Modelling\n- Dynamo / Gossip, Failure Detection and Token Ring\n- Architecture/Guarantees\n- Operating Cassandra/Hints\n- Architecture/Overview (this is proposed as a separate project)\n- Operating Cassandra/Read Repair\n- 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."]]
