cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jon Haddad (JIRA)" <>
Subject [jira] [Commented] (CASSANDRA-13907) Versioned documentation on
Date Thu, 19 Oct 2017 17:09:00 GMT


Jon Haddad commented on CASSANDRA-13907:

I had a discussion with [~mshuler] at NGCC regarding taking over updating the docs, and I've
dropped the ball, my bad on that.  As I stated above, I think it would be fantastic to have
versioned docs, but I believe we should figure out a few things first since moving on them
to early will create a massive headache in the long run.  

Here's what I think is the most efficient, least foot shooting approach to eventually get
versioned docs:

1. I'll take over the job of pushing documentation for trunk
2. We get docs in a really solid state for 4.0.  Completely comprehensive.
3. We evaluate if the current method of writing docs is the appropriate system.  I've recently
done a lot of work with [Hugo|] to write the docs for [Reaper||
and it's a lot easier to write and generate docs.  The whole Jekyl + sphinx thing is obviously
a pain point, I'd like to address this.
4. Once we're finally in good shape with documentation, we aim to make hosting multiple versions
a regular thing.

> Versioned documentation on
> -----------------------------------------------
>                 Key: CASSANDRA-13907
>                 URL:
>             Project: Cassandra
>          Issue Type: Improvement
>          Components: Documentation and Website
>            Reporter: Murukesh Mohanan
>            Priority: Minor
> Services like and make it easy to browse
the documentation for a particular version or commit of various open source projects. It would
be nice to be able to browse the docs for a particular release on
> Currently it seems only CQL has this at

This message was sent by Atlassian JIRA

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message