Re: Apache Cassandra GSoD 2019

[Nate McCall <zz...@gmail.com>]

[+gsod2019@cassandra.apache.org <de...@cassandra.apache.org> list for
visibility]
Hi Deepak,
Thanks for reaching out.

We don't have any direct pre-requisites outside of what the GSoD project
has published for technical writers:
https://developers.google.com/season-of-docs/docs/tech-writer-guide

Super cool about publishing that book!

Did you have specific ideas that you would like pursue?

Thanks,
-Nate

On Wed, May 8, 2019 at 12:20 PM Deepak Vohra <dv...@yahoo.com> wrote:

> I am interested in applying to be a technical writer for the Apache
> Cassandra GSoD 2019. What are the pre-requisites?
> As a background I have published a book on Apache Cassandra.
>
> NoSQL Web Development with Apache Cassandra
>
> https://www.amazon.com/NoSQL-Web-Development-Apache-Cassandra-ebook/dp/B00TQ8CGMW
>
> thanks,
> Deepak
>

Re: Apache Cassandra GSoD 2019

[Nate McCall <zz...@gmail.com>]

[+ GSoD list to keep everyone in the loop]
Hi Deepak,

For development of documentation, please see the following page on our site:
http://cassandra.apache.org/doc/latest/development/documentation.html

There are two workflows documented therein for small changes and large
additions respectively.

Tooling would be whatever text editor you can use to write reStructuredText
for Sphinx (see the doc above for more details). Google Draw and exporting
as a PNG or GIF is probably fine for any images.

The process is a bit cumbersome for non-coders, but we will be happy to
help answer questions and walk you through it. The main take away is that
we work through Jira for visibility and changes are submitted as patches
that will be reviewed and applied by committers. If you havent done so yet,
I highly recommend you read The Apache Way and linked documents therein to
understand this process more thoroughly:
http://www.apache.org/theapacheway/index.html

Cheers,
-Nate





On Sun, Jul 28, 2019 at 12:35 PM Deepak Vohra <dv...@yahoo.com> wrote:

> Nate,
>
> Could you please clarify  procedure to add/update documentation? I am
> assuming I shall be able to directly add new HTML pages without requesting
> someone else to do the same as that would involve unnecessary transfer of
> load.
>
> In general (please answer inline)
>
> - What HTML tool do you use/recommend to develop HTML? Is *Google Docs *
> fine?
>
> - If I find any discrepancy in config options how do I fix them? I am
> assuming the Java file settings are accurate. Please confirm. As an example
> the default value of *native_transport_port_ssl* in documentation is
> *9142* and in Java file *null*.
>
> - How do I add new documentation pages, especially the TODO pages such as
> the Backups at
> http://cassandra.apache.org/doc/latest/operating/backups.html?highlight=todo
>
> - How do I add new feature pages for version 4.0?
>
> - What software do you provide/use/recommend to make diagrams if needed?
>
> thanks,
> Deepak
>
>

Re: Apache Cassandra GSoD 2019

[Nate McCall <zz...@gmail.com>]

Hi Deepak,
4.0 Will not have binaries until we do an official release which will not
be for a while yet. You can grab a snapshot of trunk and just run it for
now.

It would be great to have this focused for different versions. However, I
would prefer we start with 4.0 and work backwards.

Cheers,
-Nate

On Fri, May 10, 2019 at 7:45 AM Deepak Vohra <dv...@yahoo.com> wrote:

> Nate,
>
> A few clarifications:
>
> 1. Each of versions 3.9, 3.11 and 4.x  have several TODO sections. I am
> interested in updating those. Do each of these versions need to be updated?
> If so, I couldn't find binaries for version 4.x. Please send link for 4.x
> binaries.
>
> 2. I couldn't find Label field in the Issues link you sent but I searched
> for "Documentation" in Components field and the following got listed. Do
> all of these need to be fixed or just the Documentation/Blog
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FBlog%22>
> ?
>
> Documentation/Blog
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FBlog%22>
> 2 Issues
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FBlog%22>
>
> Documentation/Javadoc
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FJavadoc%22>
> 5 Issues
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FJavadoc%22>
>
> Documentation/Website
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FWebsite%22>
> 10 Issues
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Documentation%2FWebsite%22>
>
> Legacy/Documentation and Website
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Legacy%2FDocumentation+and+Website%22>
> 266 Issues
> <https://issues.apache.org/jira/issues/?jql=project+%3D+CASSANDRA+AND+component+%3D+%22Legacy%2FDocumentation+and+Website%22>
>  thanks,
> Deepak
>
>
> On Thursday, May 9, 2019, 3:29:09 a.m. UTC, Nate McCall <
> zznate.m@gmail.com> wrote:
>
>
> [+ gsod2019@cassandra.apache.org for visibility]
> Hi Deepak,
>
> We have some time before we review the candidates and select them per the
> GSoD guidelines.
>
> However, being and open source project, we are happy to look at
> documentation submissions at any time. If you are interested in this,
> please feel free to look through our Jira and browse for (or create!) open
> documentation issues:
> https://issues.apache.org/jira/browse/CASSANDRA
> Sort by either "Documentation/Blog" in the Component field, or
> "Documentation" as a label.
>
> Thanks again for your interest.
>
> Cheers,
> -Nate
>
> On Thu, May 9, 2019 at 3:02 PM Deepak Vohra <dv...@yahoo.com> wrote:
>
> Nate,
>
> I have enclosed CV. I shall apply when application opens, but based on
> initial assessment if you shall be selecting me when application is
> submitted, I would prefer to get started.
>
> Please send detail.
>
> thanks,
> Deepak
>
> On Wednesday, May 8, 2019, 12:46:39 a.m. UTC, Nate McCall <
> zznate.m@gmail.com> wrote:
>
>
> [+gsod2019@cassandra.apache.org <de...@cassandra.apache.org> list for
> visibility]
> Hi Deepak,
> Thanks for reaching out.
>
> We don't have any direct pre-requisites outside of what the GSoD project
> has published for technical writers:
> https://developers.google.com/season-of-docs/docs/tech-writer-guide
>
> Super cool about publishing that book!
>
> Did you have specific ideas that you would like pursue?
>
> Thanks,
> -Nate
>
> On Wed, May 8, 2019 at 12:20 PM Deepak Vohra <dv...@yahoo.com> wrote:
>
> I am interested in applying to be a technical writer for the Apache
> Cassandra GSoD 2019. What are the pre-requisites?
> As a background I have published a book on Apache Cassandra.
>
> NoSQL Web Development with Apache Cassandra
>
> https://www.amazon.com/NoSQL-Web-Development-Apache-Cassandra-ebook/dp/B00TQ8CGMW
>
> thanks,
> Deepak
>
>

Re: Apache Cassandra GSoD 2019

[Nate McCall <zz...@gmail.com>]

[+ gsod2019@cassandra.apache.org for visibility]
Hi Deepak,

We have some time before we review the candidates and select them per the
GSoD guidelines.

However, being and open source project, we are happy to look at
documentation submissions at any time. If you are interested in this,
please feel free to look through our Jira and browse for (or create!) open
documentation issues:
https://issues.apache.org/jira/browse/CASSANDRA
Sort by either "Documentation/Blog" in the Component field, or
"Documentation" as a label.

Thanks again for your interest.

Cheers,
-Nate

On Thu, May 9, 2019 at 3:02 PM Deepak Vohra <dv...@yahoo.com> wrote:

> Nate,
>
> I have enclosed CV. I shall apply when application opens, but based on
> initial assessment if you shall be selecting me when application is
> submitted, I would prefer to get started.
>
> Please send detail.
>
> thanks,
> Deepak
>
> On Wednesday, May 8, 2019, 12:46:39 a.m. UTC, Nate McCall <
> zznate.m@gmail.com> wrote:
>
>
> [+gsod2019@cassandra.apache.org <de...@cassandra.apache.org> list for
> visibility]
> Hi Deepak,
> Thanks for reaching out.
>
> We don't have any direct pre-requisites outside of what the GSoD project
> has published for technical writers:
> https://developers.google.com/season-of-docs/docs/tech-writer-guide
>
> Super cool about publishing that book!
>
> Did you have specific ideas that you would like pursue?
>
> Thanks,
> -Nate
>
> On Wed, May 8, 2019 at 12:20 PM Deepak Vohra <dv...@yahoo.com> wrote:
>
> I am interested in applying to be a technical writer for the Apache
> Cassandra GSoD 2019. What are the pre-requisites?
> As a background I have published a book on Apache Cassandra.
>
> NoSQL Web Development with Apache Cassandra
>
> https://www.amazon.com/NoSQL-Web-Development-Apache-Cassandra-ebook/dp/B00TQ8CGMW
>
> thanks,
> Deepak
>
>