Mailing-List: contact commits-help@cassandra.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cassandra.apache.org
Date: Wed, 15 Jun 2016 19:50:09 +0000 (UTC)
From: "Tyler Hobbs (JIRA)" <jira@apache.org>
To: commits@cassandra.apache.org
Message-ID: <JIRA.12770813.1422482969000.9807.1466020209818@Atlassian.JIRA>
In-Reply-To: <JIRA.12770813.1422482969000@Atlassian.JIRA>
References: <JIRA.12770813.1422482969000@Atlassian.JIRA> <JIRA.12770813.1422482969907@arcas>
Subject: [jira] [Commented] (CASSANDRA-8700) replace the wiki with docs in
 the git repo
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Wed, 15 Jun 2016 19:50:11 -0000


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

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

Pull requests for cqlsh docs: https://github.com/pcmanus/cassandra/pull/54

> 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)