Return-Path: X-Original-To: apmail-cassandra-user-archive@www.apache.org Delivered-To: apmail-cassandra-user-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 15C751018C for ; Wed, 23 Jul 2014 11:34:13 +0000 (UTC) Received: (qmail 70921 invoked by uid 500); 23 Jul 2014 11:34:09 -0000 Delivered-To: apmail-cassandra-user-archive@cassandra.apache.org Received: (qmail 70893 invoked by uid 500); 23 Jul 2014 11:34:09 -0000 Mailing-List: contact user-help@cassandra.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: user@cassandra.apache.org Delivered-To: mailing list user@cassandra.apache.org Received: (qmail 70883 invoked by uid 99); 23 Jul 2014 11:34:09 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Jul 2014 11:34:09 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS,T_REMOTE_IMAGE X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of woolfel@gmail.com designates 209.85.220.171 as permitted sender) Received: from [209.85.220.171] (HELO mail-vc0-f171.google.com) (209.85.220.171) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Jul 2014 11:34:05 +0000 Received: by mail-vc0-f171.google.com with SMTP id hq11so1859525vcb.2 for ; Wed, 23 Jul 2014 04:33:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; bh=AjaMk9+Ggqy/RDlF3RF+sk5llMc2evz7b8r4MfFktvU=; b=ZgrOU+I1Q2qIf61N5osXV9uWvu/QSe+ZFAbfnp9fR3TheKAflHtqQCCPCiAd3Hr81k Av/G7Y3pv4llAFjEKaxJPzgu9sHWB56TaWCljIGRCzWYO6bDmsdgE/UpZd0MdSDfmLDv ictWWcNxV9mBSfs3C8tuHzUCxhZN9R5r6ShmfGZqpp6EQLHYUDsqqsjUPzBM2McxeZ04 1SRmncrqle0qLudb1QYN6mBQZd1HSx03est7c07RsDTEi2iE6Hv9z1LJPsS7Om4xbas0 wreze8NLi2GwwRkBXxLAWgvMiuNvGWVj+Iep0JdWCyzgsIRMFX3d4lLlxG4R6LIpW+vf WhBQ== MIME-Version: 1.0 X-Received: by 10.52.119.179 with SMTP id kv19mr587322vdb.3.1406115225154; Wed, 23 Jul 2014 04:33:45 -0700 (PDT) Received: by 10.221.17.198 with HTTP; Wed, 23 Jul 2014 04:33:45 -0700 (PDT) In-Reply-To: References: Date: Wed, 23 Jul 2014 07:33:45 -0400 Message-ID: Subject: Re: Why is the cassandra documentation such poor quality? From: Peter Lin To: "user@cassandra.apache.org" Content-Type: multipart/alternative; boundary=047d7bf0d902823a6e04fedab6db X-Virus-Checked: Checked by ClamAV on apache.org --047d7bf0d902823a6e04fedab6db Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable I've tried to contribute docs to Cassandra wiki in the past, but there's an obstacle. currently wiki.apache.org/cassandra is locked down, so only commiters can edit it. I really wish that wasn't the case, since it wastes time. the commiters are busy writing code. Having to email a commiter and ask them to update it feels silly to me and kind of goes against openness. Back when I was active with JMeter, we decided to leave it open so that anyone can edit the docs. I can't be the only one that wants to help make the docs better, but get frustrated with the wiki being closed. On Wed, Jul 23, 2014 at 4:25 AM, wrote: > I would like to help out with the documentation of C*. How do I start? > > > On Wed, Jul 23, 2014 at 12:46 PM, Robert Stupp wrote: > >> Just a note: >> If you have suggestions how to improve documentation on the datastax >> website, write them an email to docs@datastax.com. They appreciate >> proposals :) >> >> Am 23.07.2014 um 09:10 schrieb Mark Reddy : >> >> Hi Kevin, >> >> The difference here is that the Apache Cassandra site is maintained by >> the community whereas the DataStax site is maintained by paid employees >> with a vested interest in producing documentation. >> >> With DataStax having some comprehensive docs, I guess the desire for >> people to maintain the Apache site has dwindled. However, if you are >> interested in contributing to it and bringing it back up to standard you >> can, thus is the freedom of open source. >> >> >> Mark >> >> >> On Wed, Jul 23, 2014 at 2:54 AM, Kevin Burton wrote= : >> >>> This document: >>> >>> https://wiki.apache.org/cassandra/Operations >>> >>> =E2=80=A6 for example. Is extremely out dated=E2=80=A6 does NOT reflec= t 2.x releases >>> certainly. Mentions commands that are long since removed/deprecated. >>> >>> Instead of giving bad documentation, maybe remove this and mark it as >>> obsolete. >>> >>> The datastax documentation=E2=80=A6 is =E2=80=A6 acceptable I guess. M= y main criticism >>> there is that a lot of it it is in their blog. >>> >>> Kevin >>> >>> -- >>> >>> Founder/CEO Spinn3r.com >>> Location: *San Francisco, CA* >>> blog: http://burtonator.wordpress.com >>> =E2=80=A6 or check out my Google+ profile >>> >>> >>> >>> >> >> > > > -- > http://spawgi.wordpress.com > We can do it and do it better. > --047d7bf0d902823a6e04fedab6db Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable

I've tried to contribute docs= to Cassandra wiki in the past, but there's an obstacle.

c= urrently wiki.apache.org/cassa= ndra is locked down, so only commiters can edit it. I really wish that = wasn't the case, since it wastes time. the commiters are busy writing c= ode. Having to email a commiter and ask them to update it feels silly to me= and kind of goes against openness. Back when I was active with JMeter, we = decided to leave it open so that anyone can edit the docs.

I can't be the only one that wants to help make the docs bett= er, but get frustrated with the wiki being closed.

=


On Wed, Jul 2= 3, 2014 at 4:25 AM, <spawgi@gmail.com> wrote:
I would like to help out wi= th the documentation of C*. How do I start?


On Wed, Jul 23, 2= 014 at 12:46 PM, Robert Stupp <snazy@snazy.de> wrote:
Jus= t a note:
If you have suggestions how to improve documentation on= the datastax website, write them an email to docs@datastax.com. They appreciate proposals = :)

Am 23.07.2014 um 09:10 schrieb Mark Reddy <mark.reddy@boxever.com>= :

Hi Kevin,

The difference here is that the Apache Cassan= dra site is maintained by the community whereas the DataStax site is mainta= ined by paid employees with a vested interest in producing documentation.
With DataStax having some comprehensive docs, I guess the de= sire for people to maintain the Apache site has dwindled. However, if you a= re interested in contributing to it and bringing it back up to standard you= can, thus is the freedom of open source.=C2=A0


Mark


On Wed, Jul 23, 2014 at 2:54 AM, Kevi= n Burton <burton@spinn3r.com> wrote:
This document:


=E2=80=A6 for example. =C2=A0Is extremely out dat= ed=E2=80=A6 does NOT reflect 2.x releases certainly. =C2=A0Mentions command= s that are long since removed/deprecated.

Instead of giving bad documentation, maybe remove this = and mark it as obsolete.

The datastax documentation=E2= =80=A6 is =E2=80=A6 acceptable I guess. =C2=A0My main criticism there is th= at a lot of it it is in their blog.

Kevin

--

Founder/CEO=C2=A0Spinn3r.com
Location:=C2=A0San Francisco, CA
=E2=80=A6 or check out my Google+ profile






-- =
http://spawgi= .wordpress.com
We can do it and do it better.
--047d7bf0d902823a6e04fedab6db--