cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tyler Hobbs (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CASSANDRA-8700) replace the wiki with docs in the git repo
Date Fri, 17 Jun 2016 19:12:05 GMT

    [ https://issues.apache.org/jira/browse/CASSANDRA-8700?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15336742#comment-15336742
] 

Tyler Hobbs commented on CASSANDRA-8700:
----------------------------------------

Pull request to automatically convert cassandra.yaml into rst: https://github.com/pcmanus/cassandra/pull/57

This works pretty well overall.  There are a few minor downsides:
* I couldn't figure out a good way to handle complex options (lists and dicts) without hard
coding the option names in the script.  I considered using a yaml parser to detect these,
but that would add a dependency and wouldn't work for commented-out complex options.  Fortunately,
it's a pretty small list, and should rarely change.  If it does change without us updating
the script, it won't break anything, but the option body will end up in the next section.
* Some of the existing comments needed to be formatted slightly differently to look good in
rst.
* A couple of comments and default values don't make as much sense in the rst version.  For
example, {{allocate_tokens_for_keyspace}} has a default value of {{KEYSPACE}}, which is really
more of a placeholder.  In the rst version, this is shown as the default value, so it's a
little weird.  The number of quirks like this is fairly small, though, and they're not terrible.

Let me know what you think.

> replace the wiki with docs in the git repo
> ------------------------------------------
>
>                 Key: CASSANDRA-8700
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-8700
>             Project: Cassandra
>          Issue Type: Improvement
>          Components: Documentation and Website
>            Reporter: Jon Haddad
>            Assignee: Sylvain Lebresne
>            Priority: Blocker
>             Fix For: 3.8
>
>         Attachments: TombstonesAndGcGrace.md, bloom_filters.md, compression.md, contributing.zip,
getting_started.zip, hardware.md
>
>
> The wiki as it stands is pretty terrible.  It takes several minutes to apply a single
update, and as a result, it's almost never updated.  The information there has very little
context as to what version it applies to.  Most people I've talked to that try to use the
information they find there find it is more confusing than helpful.
> I'd like to propose that instead of using the wiki, the doc directory in the cassandra
repo be used for docs (already used for CQL3 spec) in a format that can be built to a variety
of output formats like HTML / epub / etc.  I won't start the bikeshedding on which markup
format is preferable - but there are several options that can work perfectly fine.  I've personally
use sphinx w/ restructured text, and markdown.  Both can build easily and as an added bonus
be pushed to readthedocs (or something similar) automatically.  For an example, see cqlengine's
documentation, which I think is already significantly better than the wiki: http://cqlengine.readthedocs.org/en/latest/
> In addition to being overall easier to maintain, putting the documentation in the git
repo adds context, since it evolves with the versions of Cassandra.
> If the wiki were kept even remotely up to date, I wouldn't bother with this, but not
having at least some basic documentation in the repo, or anywhere associated with the project,
is frustrating.
> For reference, the last 3 updates were:
> 1/15/15 - updating committers list
> 1/08/15 - updating contributers and how to contribute
> 12/16/14 - added a link to CQL docs from wiki frontpage (by me)



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message