From dev-return-20846-apmail-couchdb-dev-archive=couchdb.apache.org@couchdb.apache.org Wed Feb 22 01:08:14 2012 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 C71A6918E for ; Wed, 22 Feb 2012 01:08:14 +0000 (UTC) Received: (qmail 91181 invoked by uid 500); 22 Feb 2012 01:08:14 -0000 Delivered-To: apmail-couchdb-dev-archive@couchdb.apache.org Received: (qmail 91140 invoked by uid 500); 22 Feb 2012 01:08:14 -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 91132 invoked by uid 99); 22 Feb 2012 01:08:14 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 22 Feb 2012 01:08:14 +0000 X-ASF-Spam-Status: No, hits=-0.0 required=5.0 tests=RCVD_IN_DNSWL_LOW,SPF_NEUTRAL X-Spam-Check-By: apache.org Received-SPF: neutral (nike.apache.org: local policy) Received: from [209.85.212.52] (HELO mail-vw0-f52.google.com) (209.85.212.52) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 22 Feb 2012 01:08:07 +0000 Received: by vbih1 with SMTP id h1so6546863vbi.11 for ; Tue, 21 Feb 2012 17:07:46 -0800 (PST) Received-SPF: pass (google.com: domain of jhs@iriscouch.com designates 10.52.25.107 as permitted sender) client-ip=10.52.25.107; Authentication-Results: mr.google.com; spf=pass (google.com: domain of jhs@iriscouch.com designates 10.52.25.107 as permitted sender) smtp.mail=jhs@iriscouch.com Received: from mr.google.com ([10.52.25.107]) by 10.52.25.107 with SMTP id b11mr12985388vdg.37.1329872866205 (num_hops = 1); Tue, 21 Feb 2012 17:07:46 -0800 (PST) Received: by 10.52.25.107 with SMTP id b11mr10555411vdg.37.1329872866107; Tue, 21 Feb 2012 17:07:46 -0800 (PST) MIME-Version: 1.0 Received: by 10.220.106.130 with HTTP; Tue, 21 Feb 2012 17:07:26 -0800 (PST) In-Reply-To: References: From: Jason Smith Date: Wed, 22 Feb 2012 08:07:26 +0700 Message-ID: Subject: Re: API Docs (finally) To: dev@couchdb.apache.org Cc: MC Brown Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Gm-Message-State: ALoCoQljMaybi2EkxXBzgr2ZVucIGicLtSkDj9dzYPDuLCMHpccFhiMnW0sv5hNXvD0SuDqjv2Cz X-Virus-Checked: Checked by ClamAV on apache.org Jan, easy question: CouchDB is now in Git, and now there are two additional projects people are talking about: the web site and now the documentation. I wonder if the same repo could host all three projects, with dissimilar, independent history trees. (I know the web site has svn requirements but most would agree that git-svn is quite excellent dealing with this.) On Wed, Feb 22, 2012 at 3:36 AM, Jan Lehnardt wrote: > Hi all, > > I finally got my act together and prepared the CouchDB API docs that MC B= rown made for Couchbase for your consideration to be added to the project. > > I put it up on GitHub so you can check it out. > > The repo is: > > =C2=A0https://github.com/janl/couchdb-docs > > To build all docs, you run `make everything`. I put the results on GitHub= Pages. > > It includes multiple HTML builds with different granularities (single pag= e, break by section, break by chapter) as well as PDF and ePub versions: > > =C2=A0Single Page: http://janl.github.com/couchdb-docs/couchdb-manual-1.1= /couchdb-manual.html > =C2=A0By Chapter: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/= couchdb-manual.html-dir/index.html > =C2=A0By Section: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/= couchdb-manual.html-section/index.html > =C2=A0PDF: http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb= -manual.pdf > =C2=A0ePub http://janl.github.com/couchdb-docs/couchdb-manual-1.1/couchdb= -manual.epub > > There's also a CouchDB 1.1. release guide that explains all the new featu= res in depth: > > =C2=A0Single Page: http://janl.github.com/couchdb-docs/couchdb-release-1.= 1/couchdb-release-1.1.html > =C2=A0By Chapter: http://janl.github.com/couchdb-docs/couchdb-release-1.1= /couchdb-release-1.1.html-dir/index.html > =C2=A0By Section: http://janl.github.com/couchdb-docs/couchdb-release-1.1= /couchdb-release-1.1.html-section/index.html > =C2=A0PDF: http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchd= b-release-1.1.pdf > =C2=A0ePub http://janl.github.com/couchdb-docs/couchdb-release-1.1/couchd= b-release-1.1.epub > > The README.md files outlines the build dependencies. > > The license is CC 3.0 but we can adapt that to whatever is required. > > There's a few rough edges, no styling should be obvious and the few scree= nshots are using our old Single Server branded Futon, but I don't consider = these things to block adoption. > > Let me know what you think. I hope you like it! :) > > (weeee finally!) > > Cheers > Jan > -- > --=20 Iris Couch