Overview
Google is sponsoring a program called Season of Docs. Here is their description taken from their site:
...
The goal of this page is to put together a successful application for Apache Cassandra so we could get a Technical Writer in the community to improve the documentation in Cassandra. Program details are here.
Volunteers
The following people have volunteered to help out with this project. If you'd like to help out, please feel free to add your name. Alternatively, if things have changed on your end, please cross out your name.
...
Sr. | Name | |
---|---|---|
1 | Dinesh Joshi | djoshi@apache.org |
2 | Nate McCall | zznate.m@gmail.com |
3 | Chris Lohfink | clohfink@apache.org |
4 | Ben Slater | ben.slater@instaclustr.com |
5 | Rahul Singh | rahul.xavier.singh@gmail.com |
6 | Aaron Ploetz | aaronploetz@gmail.com |
7 | Horia Mocioi | a.mocioi@gmail.com |
8 | Stefan Miklosovic | stefan.miklosovic@instaclustr.com |
9 | Laxmikant Upadhyay | laxmikant.hcl@gmail.com |
Open Source Organization Administrators
TBD. The program requires each Open Source organization to have at least 2 administrators.
Application
Here are some tips to create a successful application. Timeline & Deadlines are available here. Mentoring organizations (us) can start submitting applications as soon as April 2 but the final deadline to get the application in is April 23, 2019.
...
- Project Ideas
- Provide details about working with Technical Writers and Documentation
- Previous experience working in similar programs such as Google Summer of Code, etc.
- A link to any material we publish about our participation in GSoD such as a blog post.
Potential Project Ideas
Please feel free to add project ideas below.
Update Cassandra documentation for 4.0 releaseOperator's Handbook for CassandraImproving CQL documentationDetailed nodetool documentation for operatorsGet rid of all TODOs on Cassandra Website (docs)Common Application Architecture patterns using CassandraDocument Cassandra Architecture 2.x, 3.x, 3.0.x, 4.x in detail
Project Descriptions
1 - Apache Cassandra 4.0 Documentation Update
Project Name: Apache Cassandra 4.0 Documentation Update
...
- 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
2 - Cassandra Operator's Handbook
Project Name: Apache Cassandra Operational Handbook
...
- 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
3 - Improving CQL Documentation
Project Name: Apache Cassandra CQL Documentation
...
- 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
4 - Detailed Nodetool Documentation for Operators
Project Name: Apache Cassandra Nodetool Documentation for Operators
...
- 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
5 - Resolve TODOs in Apache Cassandra Documentation
Project Name: Resolve TODOs in Apache Cassandra Documentation
...
- 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
6 - Common Application Architecture patterns using Cassandra
Project Name: Common Application Architecture patterns using Cassandra
...
- 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
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
...