It may be early, but considering first an organization has to apply, and as
I am familiar with what sections of documentation could be improved, I have a
few suggestions. Only two projects (1 and 2 of 5 listed) were completed in
2019, and GSoD expects only one project to be completed. Projects 3 and 4
listed are projects listed in 2019 also but not selected and these would be
suitable as projects to complete in 2020. I have added a fifth project about
version 4.0 improvements.
1. Apache Cassandra 4.0 Documentation Update
2. Resolve TODOs in Apache Cassandra Documentation
3. Improving CQL DocumentationApache Cassandra is a distributed database that
is seeking a qualified technical writer to create documentation for Cassandra's
Query Language (CQL). CQL, like SQL, is a query language that allows users to
interact with Cassandra. Similarly, CQL provides syntactic structures such as
DDL (Data Definition Language), DML (Data Modification Language) and DCL (Data
Control Language). CQL also has well defined grammar and syntax which may vary
with the Cassandra version. While Apache Cassandra 4.0 will be the newest
version, the documentation should also provide support for the earlier versions
of Cassandra 2.x, 3.x, and 3.11.x. There are approximately 40 CQL commands,
with several options available for each. The document should contain example
usages for each CQL command, as well as how its use varies amongst the
different versions. This could theoretically cover also some core schema design
principles and best practices, as well as how to design tables in order to
achieve optimal performance and usability.
4. Detailed Nodetool Documentation for Operators Apache Cassandra is a
distributed database that is seeking a qualified technical writer to create
documentation for Cassandra's nodetool. nodetool is a command line tool which
Cassandra operators will often use for their day-to-day operations. It is one
of the mechanisms by which an operator interacts with a node in the cluster.
Therefore, it is a critical aspect of building and managing a Cassandra
cluster. This documentation should support Cassandra 2.x, 3.x, 3.11.x, 4.x.
There are approximately 80 nodetool commands, with several options available
for each. The document should also contain examples for each nodetool command,
as well as how it varies amongst the different versions. It would be very nice
to have not only the "how" behind a particular command, but also "why" these
commands would be used. The operator should know what each command is for and
under which circumstances one should use them. It may be useful for the
commands to be grouped by category (ex: commands for grouping SSTables, et al).
There could also be some definition around frequent scenarios and workflows to
highlight using various nodetool commands to identify, debug and resolve issues
within a Cassandra cluster, in terms of every-day usage.
5. Improvements in Apache Cassandra 4.0.
thanks,Deepak
On Monday, April 27, 2020, 10:37:08 p.m. UTC, Dinesh Joshi
<[email protected]> wrote:
Folks,
GSoD 2020 is upon us. The organizational applications are due soon May 4th 2020
and I'd like us to participate in it again. GSoD 2019 brought in great deal of
improvements to the C* docs and I believe GSoD 2020 will be able to bring in
more enhancements. I realize we are also talking about docs donations from
DataStax but the docs project can be focused on 4.0 which would not overlap
with the donation. If you have opinions, please let me know.
Cheers,
Dinesh
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
