[
https://issues.apache.org/jira/browse/CASSANDRA-8700?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15334573#comment-15334573
]
Tyler Hobbs commented on CASSANDRA-8700:
----------------------------------------
bq. On the cqlsh doc though, I wonder if it's a good idea to include the
description of the command line options, and even of the special commands?
Feels like it we'll easily forgot to update it and it doesn't seem to add a lot
of value over getting the help from cqlsh directly.
I think the main advantage is that this documentation will show up in search
results. This is particularly useful if you don't know what you're looking
for, or you don't know if it's a commandline thing or a special command. I
also considered including docs for {{cqlshrc}} here for the same reason, but
those are technically already online and searchable (although not nicely
formatted).
However, it would be nice to generate the docs directly from the code, as you
mention. Sphinx works well with python, so this is probably reasonable to do.
I'll look into it.
> 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)
