From dev-return-16626-apmail-couchdb-dev-archive=couchdb.apache.org@couchdb.apache.org Mon Jun 13 18:27:28 2011 Return-Path: X-Original-To: apmail-couchdb-dev-archive@www.apache.org Delivered-To: apmail-couchdb-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 77ACB62DC for ; Mon, 13 Jun 2011 18:27:28 +0000 (UTC) Received: (qmail 35703 invoked by uid 500); 13 Jun 2011 18:27:27 -0000 Delivered-To: apmail-couchdb-dev-archive@couchdb.apache.org Received: (qmail 35652 invoked by uid 500); 13 Jun 2011 18:27:27 -0000 Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list dev@couchdb.apache.org Received: (qmail 35644 invoked by uid 99); 13 Jun 2011 18:27:27 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Jun 2011 18:27:27 +0000 X-ASF-Spam-Status: No, hits=-0.7 required=5.0 tests=FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,RFC_ABUSE_POST,SPF_PASS,T_TO_NO_BRKTS_FREEMAIL X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of robert.newson@gmail.com designates 209.85.210.180 as permitted sender) Received: from [209.85.210.180] (HELO mail-iy0-f180.google.com) (209.85.210.180) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Jun 2011 18:27:22 +0000 Received: by iyh42 with SMTP id 42so6610631iyh.11 for ; Mon, 13 Jun 2011 11:27:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:in-reply-to:references:date :message-id:subject:from:to:content-type:content-transfer-encoding; bh=xWfCw7NuRssKCSSXUighE9/XpPVJ4aD8IA8Br3lxZnI=; b=I+O0Ts2uzvqwgoxkDG3GUHlwnBE4tFQgQhGkoFGsfeOJAscQxzPEpmIHHDgof8k/hD wJiG4mZsZRv45I4Gt8W2utdEYB2QMpgsldlb0cLlRRyK5rhfa2gCReeHWF8iYZelJLTI bNteQccfKODWT6RJ7r1m8sjdqLxsd5idJUaVU= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type:content-transfer-encoding; b=mXUh+CSI4iFBRqwXf/x9k10i79HodBgs3onG+gwvehM4fgphLq+L0oTXeJk4HDrO9V hcnj6ZMkrbHnf2tN8496JOEb0Aux6VbS7bKH9k6x1iKPVZf0gnYUvxDPs2zsofZR/K6W T5kJciYQK1EYnfdlgxBgH/2DAo+whPIIFV6As= MIME-Version: 1.0 Received: by 10.42.166.131 with SMTP id o3mr6538668icy.98.1307989621954; Mon, 13 Jun 2011 11:27:01 -0700 (PDT) Received: by 10.231.184.143 with HTTP; Mon, 13 Jun 2011 11:27:01 -0700 (PDT) In-Reply-To: <554B01BE-D1F2-4B6E-97D2-E8E93F50EE47@dionne-associates.com> References: <20110613070433.1622.84988@eos.apache.org> <02E53EA0-4601-437F-9B18-72A74803D712@apache.org> <88A56E96-AEB9-4A89-BEF4-E05C67B1DE7D@apache.org> <83D9EFA2-D580-4563-981F-EAE8EB6F29DC@apache.org> <4DF620CD.3050904@autonomy.com> <554B01BE-D1F2-4B6E-97D2-E8E93F50EE47@dionne-associates.com> Date: Mon, 13 Jun 2011 19:27:01 +0100 Message-ID: Subject: Re: [Couchdb Wiki] Trivial Update of "CouchDB_in_the_wild" by wentforgold From: Robert Newson To: dev@couchdb.apache.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable +1 for commit requirement in addition to being a release requirement. At the very least, we get the docs fixed during the release process, but it ought to be done with the commit itself. In practice, we'll forget sometimes, and then be reminded by others on the team. B. On 13 June 2011 19:17, Robert Dionne wrote: > ++1++ > > On Jun 13, 2011, at 2:08 PM, Paul Davis wrote: > >> On Mon, Jun 13, 2011 at 2:05 PM, Robert Newson = wrote: >>> It's not the wiki per se that bothers me, it's that it's the primary, >>> often only, source of documentation. >>> >>> I propose that future releases of CouchDB include at least a full >>> description of all public API's. Improvements above that base level >>> would be a manual and/or simple tutorials. >>> >>> This documentation would be maintained in the same source tree as the >>> code and it would be a release requirement for this documentation to >>> be updated to include all new features. >>> >> >> You had me until you said "release requirement". I would upgrade that >> to "commit requirement" if we're seriously about having such >> documentation. If we don't force people to make sure docs reflect >> changes at commit time then its probably going to be a lost cause. >> >>> This documentation is then the primary source, the wiki can serve as a >>> supplement. >>> >>> b. >>> >>> On 13 June 2011 18:16, Peter Nolan wrote: >>>> Any documentation is good. >>>> >>>> What is this 'spam'? =A0Haven't personally encountered anything on the= wiki >>>> that would be 'considered' spam (perhaps not stumbled upon that portio= n?) >>>> >>>> But it's inevitable that the wiki will be attacked by unscrupulous peo= ple >>>> and as such, the wiki should prepare for this. =A0The wiki is going to= need >>>> gatekeepers/admins to maintain it. >>>> >>>> It would be nice, that any edits be archived so users can see previous >>>> states of the page if they so choose so. >>>> >>>> >>>> If a noted jerk keeps editing the wiki, we should have a system that o= nly >>>> applies his edits to his account. =A0The common user would not see his= edits, >>>> only he would, which would hopefully convince him that his edit has go= ne >>>> through. >>>> >>>> +1 top hats. >>>> >>> > >