There’s a section dedicated to contributing to Cassandra documentation in the docs as well: https://cassandra.apache.org/doc/latest/development/documentation.html <https://cassandra.apache.org/doc/latest/development/documentation.html>
> On Feb 27, 2018, at 9:55 AM, Kenneth Brotman <kenbrot...@yahoo.com.INVALID> > wrote: > > I was just getting ready to install sphinx. Cool. > > From: Jon Haddad [mailto:jonathan.had...@gmail.com] On Behalf Of Jon Haddad > Sent: Tuesday, February 27, 2018 9:51 AM > To: user@cassandra.apache.org > Subject: Re: Filling in the blank To Do sections on the Apache Cassandra web > site > > The docs have been in tree for years :) > > https://github.com/apache/cassandra/tree/trunk/doc > <https://github.com/apache/cassandra/tree/trunk/doc> > > There’s even a docker image to build them so you don’t need to mess with > sphinx. Check the README for instructions. > > Jon > > > On Feb 27, 2018, at 9:49 AM, Carl Mueller <carl.muel...@smartthings.com > <mailto:carl.muel...@smartthings.com>> wrote: > > If there was a github for the docs, we could start posting content to it for > review. Not sure what the review/contribution process is on Apache. Google > searches on apache documentation and similar run into lots of noise from > actual projects. > > I wouldn't mind trying to do a little doc work on the regular if there was a > wiki, a proven means to do collaborative docs. > > > On Tue, Feb 27, 2018 at 11:42 AM, Kenneth Brotman > <kenbrot...@yahoo.com.invalid <mailto:kenbrot...@yahoo.com.invalid>> wrote: > It’s just content for web pages. There isn’t a working outline or any draft > on any of the JIRA’s yet. I like to keep things simple. Did I miss > something? What does it matter right now? > > Thanks Carl, > > Kenneth Brotman > > From: Carl Mueller [mailto:carl.muel...@smartthings.com > <mailto:carl.muel...@smartthings.com>] > Sent: Tuesday, February 27, 2018 8:50 AM > To: user@cassandra.apache.org <mailto:user@cassandra.apache.org> > Subject: Re: Filling in the blank To Do sections on the Apache Cassandra web > site > > so... are those pages in the code tree of github? I don't see them or a > directory structure under /doc. Is mirroring the documentation between the > apache site and a github source a big issue? > > On Tue, Feb 27, 2018 at 7:50 AM, Kenneth Brotman > <kenbrot...@yahoo.com.invalid <mailto:kenbrot...@yahoo.com.invalid>> wrote: > I was debating that. Splitting it up into smaller tasks makes each one seem > less over-whelming. > > Kenneth Brotman > > From: Josh McKenzie [mailto:jmckenzie@apacheorg > <mailto:jmcken...@apache.org>] > Sent: Tuesday, February 27, 2018 5:44 AM > To: cassandra > Subject: Re: Filling in the blank To Do sections on the Apache Cassandra web > site > > Might help, organizationally, to put all these efforts under a single ticket > of "Improve web site Documentation" and add these as sub-tasks Should be able > to do that translation post-creation (i.e. in its current state) if that's > something that makes sense to you. > > On Mon, Feb 26, 2018 at 5:24 PM, Kenneth Brotman > <kenbrot...@yahoo.com.invalid <mailto:kenbrot...@yahoo.com.invalid>> wrote: > Here are the related JIRA’s. Please add content even if It’s not well formed > compositionally. Myself or someone else will take it from there > > https://issues.apache.org/jira/browse/CASSANDRA-14274 > <https://issues.apache.org/jira/browse/CASSANDRA-14274> The troubleshooting > section of the web site is empty > https://issues.apache.org/jira/browse/CASSANDRA-14273 > <https://issues.apache.org/jira/browse/CASSANDRA-14273> The Bulk Loading web > page on the web site is empty > https://issues.apache.org/jira/browse/CASSANDRA-14272 > <https://issues.apache.org/jira/browse/CASSANDRA-14272> The Backups web page > on the web site is empty > https://issues.apache.org/jira/browse/CASSANDRA-14271 > <https://issues.apache.org/jira/browse/CASSANDRA-14271> The Hints web page > in the web site is empty > https://issues.apache.org/jira/browse/CASSANDRA-14270 > <https://issues.apache.org/jira/browse/CASSANDRA-14270> The Read repair web > page is empty > https://issuesapache.org/jira/browse/CASSANDRA-14269 > <https://issues.apache.org/jira/browse/CASSANDRA-14269> The Data Modeling > section of the web site is empty > https://issues.apache.org/jira/browse/CASSANDRA-14268 > <https://issues.apache.org/jira/browse/CASSANDRA-14268> The > Architecture:Guarantees web page is empty > https://issuesapache.org/jira/browse/CASSANDRA-14267 > <https://issues.apache.org/jira/browse/CASSANDRA-14267> The Dynamo web page > on the Apache Cassandra site is missing content > https://issues.apache.org/jira/browse/CASSANDRA-14266 > <https://issues.apache.org/jira/browse/CASSANDRA-14266> The Architecture > Overview web page on the Apache Cassandra site is empty > > Thanks for pitching in > > Kenneth Brotman > > From: Kenneth Brotman [mailto:kenbrot...@yahoo.com.INVALID > <mailto:kenbrot...@yahoo.com.INVALID>] > Sent: Monday, February 26, 2018 1:54 PM > To: user@cassandra.apache.org <mailto:user@cassandra.apache.org> > Subject: RE: Filling in the blank To Do sections on the Apache Cassandra web > site > > Nice! Thanks for the help Oliver! > > Kenneth Brotman > > From: Oliver Ruebenacker [mailto:cur...@gmail.com <mailto:cur...@gmail.com>] > Sent: Sunday, February 25, 2018 7:12 AM > To: user@cassandra.apache.org <mailto:user@cassandra.apache.org> > Cc: dev@cassandra.apacheorg <mailto:d...@cassandra.apache.org> > Subject: Re: Filling in the blank To Do sections on the Apache Cassandra web > site > > > Hello, > > I have some slides about Cassandra > <https://docs.google.com/presentation/d/1JZYugL4WC9grgZswg1i6gAfWmFBqg9iQ0YcPLUiQ-6w/edit?usp=sharing>, > feel free to borrow. > > Best, Oliver > > On Fri, Feb 23, 2018 at 7:28 PM, Kenneth Brotman > <kenbrot...@yahoo.com.invalid <mailto:kenbrot...@yahoo.com.invalid>> wrote: > These nine web pages on the Apache Cassandra web site have blank To Do > sections. Most of the web pages are completely blank. Mind you there is a > lot of hard work already done on the documentation. I’ll make JIRA’s for any > of the blank sections where there is not already a JIRA. Then it will be on > to writing up those sections. If you have any text to help me get started > for any of these sections that would be really cool. > > > > http://cassandra.apache.org/doc/latest/architecture/overview.html > <http://cassandra.apache.org/doc/latest/architecture/overview.html> > > > http://cassandra.apacheorg/doc/latest/architecture/dynamo.html > <http://cassandra.apache.org/doc/latest/architecture/dynamo.html> > > > http://cassandra.apache.org/doc/latest/architecture/guarantees.html > <http://cassandra.apache.org/doc/latest/architecture/guaranteeshtml> > > > http://cassandra.apache.org/doc/latest/data_modeling/index.html > <http://cassandra.apache.org/doc/latest/data_modeling/index.html> > > > http://cassandra.apacheorg/doc/latest/operating/read_repair.html > <http://cassandra.apache.org/doc/latest/operating/read_repair.html> > > > http://cassandra.apache.org/doc/latest/operating/hints.html > <http://cassandra.apache.org/doc/latest/operating/hints.html> > > > http://cassandra.apache.org/doc/latest/operating/backups.html > <http://cassandra.apache.org/doc/latest/operating/backups.html> > > > http://cassandra.apache.org/doc/latest/operating/bulk_loading.html > <http://cassandra.apache.org/doc/latest/operating/bulk_loading.html> > > > http://cassandra.apache.org/doc/latest/troubleshooting/index.html > <http://cassandra.apache.org/doc/latest/troubleshooting/index.html> > > > Kenneth Brotman > > > > > -- > Oliver Ruebenacker > Senior Software Engineer, Diabetes Portal > <http://www.type2diabetesgenetics.org/>, Broad Institute > <http://www.broadinstitute.org/>
