You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cassandra.apache.org by sharanf <sh...@apache.org> on 2022/10/18 10:28:05 UTC
Looking for documentation tasks to work on
Hi All
It was really good to be at ApacheCon in New Orleans and finally put
some real faces to the names I've seen on the mailing list. And sitting
in the Cassandra BOF session has made me even more motivated to help
out. I've been thinking of getting involved and contributing to the docs
so please can someone point me in the direction of something that needs
doing around documentation :-)
Thanks
Sharan
Re: Looking for documentation tasks to work on
Posted by Sharan Foga <sh...@apache.org>.
Hi Josh
I've added a note for Jordan in the Jira Ticket https://issues.apache.org/jira/browse/CASSANDRA-17547 to see if he's still on it and if not then I'd be happy to take it. It looks like a conversion of the rst format to adoc then adding it back into the docs structure.
Thanks
Sharan
On 2022/10/20 07:56:57 Sharan Foga wrote:
> Hi Josh
>
> Excellent and thanks for this. I'll take a look.
>
> Thanks
> Sharan
>
> On 2022/10/18 20:35:50 Josh McKenzie wrote:
> > Hey Sharan! Documentation is near and dear to my heart; the longer I spend on this project the more I think it's one of the higher leverage things we can invest our energy into. A general high level view of open documentation work in the project in reverse key order can be found here: https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
> >
> > Specifically I have my eye on our CI and contribution process and should have a variety of documentation tickets opening up based on some of the changes Andres made in CASSANDRA-17939 and some follow up work (see comment here if curious: https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880)
> >
> > If I'm not mistaken Derek said he ran into some dead / not working links in the how to contribute structure (link: https://cassandra.apache.org/_/development/index.html) - @Derek were you taking that or is that part of the above workload?)
> >
> > And at the risk of flooding you w/too many options, last but not least is a pretty straightforward resurrection of some documentation that got dropped for the Denylisting functionality (https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping Jordan West on ASF slack to see if he's active on that ticket. Of all the issues that may be one of the more straightforward.
> >
> > Hit me up on slack with any questions and glad to have you here!
> >
> > ~Josh
> >
> > On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
> > > Hi All
> > >
> > > It was really good to be at ApacheCon in New Orleans and finally put
> > > some real faces to the names I've seen on the mailing list. And sitting
> > > in the Cassandra BOF session has made me even more motivated to help
> > > out. I've been thinking of getting involved and contributing to the docs
> > > so please can someone point me in the direction of something that needs
> > > doing around documentation :-)
> > >
> > > Thanks
> > > Sharan
> > >
> >
>
Re: Looking for documentation tasks to work on
Posted by Sharan Foga <sh...@apache.org>.
Hi Josh
Excellent and thanks for this. I'll take a look.
Thanks
Sharan
On 2022/10/18 20:35:50 Josh McKenzie wrote:
> Hey Sharan! Documentation is near and dear to my heart; the longer I spend on this project the more I think it's one of the higher leverage things we can invest our energy into. A general high level view of open documentation work in the project in reverse key order can be found here: https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
>
> Specifically I have my eye on our CI and contribution process and should have a variety of documentation tickets opening up based on some of the changes Andres made in CASSANDRA-17939 and some follow up work (see comment here if curious: https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880)
>
> If I'm not mistaken Derek said he ran into some dead / not working links in the how to contribute structure (link: https://cassandra.apache.org/_/development/index.html) - @Derek were you taking that or is that part of the above workload?)
>
> And at the risk of flooding you w/too many options, last but not least is a pretty straightforward resurrection of some documentation that got dropped for the Denylisting functionality (https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping Jordan West on ASF slack to see if he's active on that ticket. Of all the issues that may be one of the more straightforward.
>
> Hit me up on slack with any questions and glad to have you here!
>
> ~Josh
>
> On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
> > Hi All
> >
> > It was really good to be at ApacheCon in New Orleans and finally put
> > some real faces to the names I've seen on the mailing list. And sitting
> > in the Cassandra BOF session has made me even more motivated to help
> > out. I've been thinking of getting involved and contributing to the docs
> > so please can someone point me in the direction of something that needs
> > doing around documentation :-)
> >
> > Thanks
> > Sharan
> >
>
Re: Looking for documentation tasks to work on
Posted by Sharan Foga <sh...@apache.org>.
Hi Paulo
Great to meet you at ApacheCon! And thanks for this suggestion - it's on my list :-)
Thanks
Sharan
On 2022/10/19 14:37:26 Paulo Motta wrote:
> Welcome Sharan! :)
>
> One of the features that is going to be released in 4.1 is the ability to
> add TTL to snapshots, but this hasn't been documented yet afaik.
>
> There's a preliminary documentation patch available on
> https://issues.apache.org/jira/browse/CASSANDRA-16887 if you want to take a
> stab at it.
>
> Em ter., 18 de out. de 2022 às 16:36, Josh McKenzie <jm...@apache.org>
> escreveu:
>
> > Hey Sharan! Documentation is near and dear to my heart; the longer I spend
> > on this project the more I think it's one of the higher leverage things we
> > can invest our energy into. A general high level view of open documentation
> > work in the project in reverse key order can be found here:
> > https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
> >
> > Specifically I have my eye on our CI and contribution process and should
> > have a variety of documentation tickets opening up based on some of the
> > changes Andres made in CASSANDRA-17939 and some follow up work (see comment
> > here if curious:
> > https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880
> > )
> >
> > If I'm not mistaken Derek said he ran into some dead / not working links
> > in the how to contribute structure (link:
> > https://cassandra.apache.org/_/development/index.html) - @Derek were you
> > taking that or is that part of the above workload?)
> >
> > And at the risk of flooding you w/too many options, last but not least is
> > a pretty straightforward resurrection of some documentation that got
> > dropped for the Denylisting functionality (
> > https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping
> > Jordan West on ASF slack to see if he's active on that ticket. Of all the
> > issues that may be one of the more straightforward.
> >
> > Hit me up on slack with any questions and glad to have you here!
> >
> > ~Josh
> >
> > On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
> >
> > Hi All
> >
> > It was really good to be at ApacheCon in New Orleans and finally put
> > some real faces to the names I've seen on the mailing list. And sitting
> > in the Cassandra BOF session has made me even more motivated to help
> > out. I've been thinking of getting involved and contributing to the docs
> > so please can someone point me in the direction of something that needs
> > doing around documentation :-)
> >
> > Thanks
> > Sharan
> >
> >
> >
>
Re: Looking for documentation tasks to work on
Posted by Sharan Foga <sh...@apache.org>.
Hi Ekaterina
Thanks for the suggestion! Looks like documentation is a hot topic so great there are a few opportunities to get involved. :-)
Thanks
Sharan
On 2022/10/19 15:06:23 Ekaterina Dimitrova wrote:
> One more idea, I was looking to update the What’s new page - a few links to
> docs or blog pages and referral to NEWS.txt and CHANGES.txt maybe.
> Currently the 4.1 and trunk What’s new pages point to the 4.0 one things
> and the config docs only. I will open a ticket later today. That should be
> a quick fix I think but nice to have now when beta is out.
>
> On Wed, 19 Oct 2022 at 10:37, Paulo Motta <pa...@apache.org> wrote:
>
> > Welcome Sharan! :)
> >
> > One of the features that is going to be released in 4.1 is the ability to
> > add TTL to snapshots, but this hasn't been documented yet afaik.
> >
> > There's a preliminary documentation patch available on
> > https://issues.apache.org/jira/browse/CASSANDRA-16887 if you want to take
> > a stab at it.
> >
> > Em ter., 18 de out. de 2022 às 16:36, Josh McKenzie <jm...@apache.org>
> > escreveu:
> >
> >> Hey Sharan! Documentation is near and dear to my heart; the longer I
> >> spend on this project the more I think it's one of the higher leverage
> >> things we can invest our energy into. A general high level view of open
> >> documentation work in the project in reverse key order can be found here:
> >> https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
> >>
> >> Specifically I have my eye on our CI and contribution process and should
> >> have a variety of documentation tickets opening up based on some of the
> >> changes Andres made in CASSANDRA-17939 and some follow up work (see comment
> >> here if curious:
> >> https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880
> >> )
> >>
> >> If I'm not mistaken Derek said he ran into some dead / not working links
> >> in the how to contribute structure (link:
> >> https://cassandra.apache.org/_/development/index.html) - @Derek were you
> >> taking that or is that part of the above workload?)
> >>
> >> And at the risk of flooding you w/too many options, last but not least is
> >> a pretty straightforward resurrection of some documentation that got
> >> dropped for the Denylisting functionality (
> >> https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping
> >> Jordan West on ASF slack to see if he's active on that ticket. Of all the
> >> issues that may be one of the more straightforward.
> >>
> >> Hit me up on slack with any questions and glad to have you here!
> >>
> >> ~Josh
> >>
> >> On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
> >>
> >> Hi All
> >>
> >> It was really good to be at ApacheCon in New Orleans and finally put
> >> some real faces to the names I've seen on the mailing list. And sitting
> >> in the Cassandra BOF session has made me even more motivated to help
> >> out. I've been thinking of getting involved and contributing to the docs
> >> so please can someone point me in the direction of something that needs
> >> doing around documentation :-)
> >>
> >> Thanks
> >> Sharan
> >>
> >>
> >>
>
Re: Looking for documentation tasks to work on
Posted by Ekaterina Dimitrova <e....@gmail.com>.
One more idea, I was looking to update the What’s new page - a few links to
docs or blog pages and referral to NEWS.txt and CHANGES.txt maybe.
Currently the 4.1 and trunk What’s new pages point to the 4.0 one things
and the config docs only. I will open a ticket later today. That should be
a quick fix I think but nice to have now when beta is out.
On Wed, 19 Oct 2022 at 10:37, Paulo Motta <pa...@apache.org> wrote:
> Welcome Sharan! :)
>
> One of the features that is going to be released in 4.1 is the ability to
> add TTL to snapshots, but this hasn't been documented yet afaik.
>
> There's a preliminary documentation patch available on
> https://issues.apache.org/jira/browse/CASSANDRA-16887 if you want to take
> a stab at it.
>
> Em ter., 18 de out. de 2022 às 16:36, Josh McKenzie <jm...@apache.org>
> escreveu:
>
>> Hey Sharan! Documentation is near and dear to my heart; the longer I
>> spend on this project the more I think it's one of the higher leverage
>> things we can invest our energy into. A general high level view of open
>> documentation work in the project in reverse key order can be found here:
>> https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
>>
>> Specifically I have my eye on our CI and contribution process and should
>> have a variety of documentation tickets opening up based on some of the
>> changes Andres made in CASSANDRA-17939 and some follow up work (see comment
>> here if curious:
>> https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880
>> )
>>
>> If I'm not mistaken Derek said he ran into some dead / not working links
>> in the how to contribute structure (link:
>> https://cassandra.apache.org/_/development/index.html) - @Derek were you
>> taking that or is that part of the above workload?)
>>
>> And at the risk of flooding you w/too many options, last but not least is
>> a pretty straightforward resurrection of some documentation that got
>> dropped for the Denylisting functionality (
>> https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping
>> Jordan West on ASF slack to see if he's active on that ticket. Of all the
>> issues that may be one of the more straightforward.
>>
>> Hit me up on slack with any questions and glad to have you here!
>>
>> ~Josh
>>
>> On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
>>
>> Hi All
>>
>> It was really good to be at ApacheCon in New Orleans and finally put
>> some real faces to the names I've seen on the mailing list. And sitting
>> in the Cassandra BOF session has made me even more motivated to help
>> out. I've been thinking of getting involved and contributing to the docs
>> so please can someone point me in the direction of something that needs
>> doing around documentation :-)
>>
>> Thanks
>> Sharan
>>
>>
>>
Re: Looking for documentation tasks to work on
Posted by Paulo Motta <pa...@apache.org>.
Welcome Sharan! :)
One of the features that is going to be released in 4.1 is the ability to
add TTL to snapshots, but this hasn't been documented yet afaik.
There's a preliminary documentation patch available on
https://issues.apache.org/jira/browse/CASSANDRA-16887 if you want to take a
stab at it.
Em ter., 18 de out. de 2022 às 16:36, Josh McKenzie <jm...@apache.org>
escreveu:
> Hey Sharan! Documentation is near and dear to my heart; the longer I spend
> on this project the more I think it's one of the higher leverage things we
> can invest our energy into. A general high level view of open documentation
> work in the project in reverse key order can be found here:
> https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
>
> Specifically I have my eye on our CI and contribution process and should
> have a variety of documentation tickets opening up based on some of the
> changes Andres made in CASSANDRA-17939 and some follow up work (see comment
> here if curious:
> https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880
> )
>
> If I'm not mistaken Derek said he ran into some dead / not working links
> in the how to contribute structure (link:
> https://cassandra.apache.org/_/development/index.html) - @Derek were you
> taking that or is that part of the above workload?)
>
> And at the risk of flooding you w/too many options, last but not least is
> a pretty straightforward resurrection of some documentation that got
> dropped for the Denylisting functionality (
> https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping
> Jordan West on ASF slack to see if he's active on that ticket. Of all the
> issues that may be one of the more straightforward.
>
> Hit me up on slack with any questions and glad to have you here!
>
> ~Josh
>
> On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
>
> Hi All
>
> It was really good to be at ApacheCon in New Orleans and finally put
> some real faces to the names I've seen on the mailing list. And sitting
> in the Cassandra BOF session has made me even more motivated to help
> out. I've been thinking of getting involved and contributing to the docs
> so please can someone point me in the direction of something that needs
> doing around documentation :-)
>
> Thanks
> Sharan
>
>
>
Re: Looking for documentation tasks to work on
Posted by Josh McKenzie <jm...@apache.org>.
Hey Sharan! Documentation is near and dear to my heart; the longer I spend on this project the more I think it's one of the higher leverage things we can invest our energy into. A general high level view of open documentation work in the project in reverse key order can be found here: https://issues.apache.org/jira/issues/?jql=project%20%3D%20cassandra%20and%20resolution%20%3D%20unresolved%20and%20summary%20~%20%22documentation%22%20order%20by%20issuekey%20desc
Specifically I have my eye on our CI and contribution process and should have a variety of documentation tickets opening up based on some of the changes Andres made in CASSANDRA-17939 and some follow up work (see comment here if curious: https://issues.apache.org/jira/browse/CASSANDRA-17939?focusedCommentId=17617880&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617880)
If I'm not mistaken Derek said he ran into some dead / not working links in the how to contribute structure (link: https://cassandra.apache.org/_/development/index.html) - @Derek were you taking that or is that part of the above workload?)
And at the risk of flooding you w/too many options, last but not least is a pretty straightforward resurrection of some documentation that got dropped for the Denylisting functionality (https://issues.apache.org/jira/browse/CASSANDRA-17547) - you can ping Jordan West on ASF slack to see if he's active on that ticket. Of all the issues that may be one of the more straightforward.
Hit me up on slack with any questions and glad to have you here!
~Josh
On Tue, Oct 18, 2022, at 6:28 AM, sharanf wrote:
> Hi All
>
> It was really good to be at ApacheCon in New Orleans and finally put
> some real faces to the names I've seen on the mailing list. And sitting
> in the Cassandra BOF session has made me even more motivated to help
> out. I've been thinking of getting involved and contributing to the docs
> so please can someone point me in the direction of something that needs
> doing around documentation :-)
>
> Thanks
> Sharan
>