Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.NameEmail
1Dinesh Joshidjoshi@apache.org
2Nate McCallzznate.m@gmail.com
3Chris Lohfinkclohfink@apache.org
4Ben Slaterben.slater@instaclustr.com
5Rahul Singhrahul.xavier.singh@gmail.com
6Aaron Ploetzaaronploetz@gmail.com
7Horia Mocioia.mocioi@gmail.com
8Stefan Miklosovicstefan.miklosovic@instaclustr.com
9Laxmikant Upadhyaylaxmikant.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.

  1. Update Cassandra documentation for 4.0 release
  2. Operator's Handbook for Cassandra
  3. Improving CQL documentation
  4. Detailed nodetool documentation for operators
  5. Get rid of all TODOs on Cassandra Website (docs)
  6. Common Application Architecture patterns using Cassandra
  7. Document 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

...

2 - Cassandra Operator's Handbook

Project Name: Apache Cassandra Operational Handbook

...


3 - Improving CQL Documentation

Project Name: Apache Cassandra CQL Documentation

...


4 - Detailed Nodetool Documentation for Operators

Project Name: Apache Cassandra Nodetool Documentation for Operators

...


5 - Resolve TODOs in Apache Cassandra Documentation

Project Name: Resolve TODOs in Apache Cassandra Documentation

...


6 - Common Application Architecture patterns using Cassandra

Project Name: Common Application Architecture patterns using Cassandra

...

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

...