Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
Date: Sun, 2 Jun 2013 18:45:21 +0000 (UTC)
From: "Jan Lehnardt (JIRA)" <jira@apache.org>
To: dev@couchdb.apache.org
Message-ID: <JIRA.12645248.1367250240996.53549.1370198721521@arcas>
In-Reply-To: <JIRA.12645248.1367250240996@arcas>
References: <JIRA.12645248.1367250240996@arcas>
Subject: [jira] [Commented] (COUCHDB-1781) Reorganize/improve docs articles
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


    [ https://issues.apache.org/jira/browse/COUCHDB-1781?page=3Dcom.atlassi=
an.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D13=
672638#comment-13672638 ]=20

Jan Lehnardt commented on COUCHDB-1781:
---------------------------------------

This is an excellent list. The only edit (yay bikeshed) is to put a =E2=80=
=9Cquick start guide=E2=80=9D on position 0. that gets you up and running i=
n 5 minutes and through the basics in 10 more minutes. Kind of like http://=
guide.couchdb.org/draft/tour.html but in good :)
               =20
> Reorganize/improve docs articles
> --------------------------------
>
>                 Key: COUCHDB-1781
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1781
>             Project: CouchDB
>          Issue Type: Documentation
>          Components: Documentation
>            Reporter: Alexander Shorin
>            Assignee: Alexander Shorin
>
> Documentation articles need to reorganize to let them easily answer on ne=
wbie questions who never seen CouchDB before in logical order they raised. =
For example:
> 1. What is CouchDB?
> 2. How to install it?
> 3. How to configure it?
> 4. How to administrate it? [1]
> 4.1 Setup users
> 4.2 Security features=20
> 4.x etc.
> 5. How to manage it? Basic API overview.=20
> 6. What features it has?
> 6.1 Changes feed
> 6.2 CORs
> 6.3 Externals
> 6.x etc. for features that may be described in single page.
> 7. Replications
> 7.x what it is, how it works, how to use it etc.
> 8. More about couchapps [2]
> 8.x what it is, how it works, how to use it etc.
> 9. Extending CouchDB
> 10. Complete Guide to CouchDB HTTP API
> 11. Some input on CouchDB internals
> 12. Troubleshooting, common problems and their solutions
> 13. Some glossary of common terms to easily understand by new users
> 14. Release notes and changes history to track features.
> and so on. For sure, some points need to be more detail like
> Replication: there are two ways to start data replication; conflicts and =
their solution; common practises for them and so forth.
> As the inspiration source the PostgreSQL docs was used:
> http://www.postgresql.org/docs/9.2/static/index.html
> [1]: I believe, that better to guide users to use Futon for the first ste=
ps instead of fighting with curl on CLI.=20
> [2]: Should docs promote tools like erica, kanso and other popular ones t=
hat are still been recommended on mailing lists/IRC? Question may also stan=
ds as "how much batteries to include?".
> [3]: GeoCouch, Lucene, OX_Auth, etc. and how to write your own. Same ques=
tion about promotion of third party tools. On one hand they are third party=
, but on other they are not so much to stay aside and raising initial inter=
est to them may provoke to create more of them.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrato=
rs
For more information on JIRA, see: http://www.atlassian.com/software/jira