Versions Compared

Old Version 14

changes.mady.by.user Aaron Ploetz

Saved on

compared with

New Version Current

changes.mady.by.user Mick Wever

Saved on

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.

We need to get together the following -

  •  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

...

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.

...


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

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.

...


6 - Common Application Architecture patterns using Cassandra

Project Name: Common Application Architecture patterns using Cassandra

...

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.

...

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

...

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:

  1. General Cassandra Architecture
  2. Code organizationOganization
  3. Storage Engine
  4. Internode Communication
  5. Native Protocol
  6. Secondary Indexes
  7. Materialized Views
  8. 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:

...