Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
Received-SPF: pass (nike.apache.org: domain of kxepal@gmail.com designates
 74.125.82.50 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <BB22AF6F-74EB-4207-893A-86B76A88A09A@programmazione.it>
References: 
 <CAHdjipJwktCD9cHkQx0vQObNxVFB+1RP3i35jKkP_56+TCs8Hg@mail.gmail.com>
	<3923359E-7F63-4DDE-9CDE-BFF070FA4CCD@programmazione.it>
	<CAHdjipKefuDdguiE8WcpiJBhs2A0A-S6CRv_aG1JVTKb_HsuvQ@mail.gmail.com>
	<BB22AF6F-74EB-4207-893A-86B76A88A09A@programmazione.it>
Date: Thu, 25 Jul 2013 04:38:47 +0400
Message-ID: 
 <CAHdjipLJaiO3HhodG5F9gHsr-ADumf=41KwgcfSUahUc9mmPOA@mail.gmail.com>
Subject: Re: [REVIEW] Docs update
From: Alexander Shorin <kxepal@gmail.com>
To: "dev@couchdb.apache.org" <dev@couchdb.apache.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

On Thu, Jul 25, 2013 at 4:16 AM, Filippo Fadda
<filippo.fadda@programmazione.it> wrote:
> On Jul 25, 2013, at 12:44 AM, Alexander Shorin wrote:
>> That's why installation guides (from sources, using system package
>> manager etc.) have to be in docs.
>
> I'm not telling they shouldn't be there, I'm telling, in the doc, you wan=
t find all:
>
> - Mac OS X
>         Download the image (with the link to download)
>         Install using MacPorts
>         Install using Brew
>
> - Linux
>         Install using apt-get (Ubuntu, Debian)
>         Install using yum (CentOS, RedHat, Fedora)
>         Gentoo (someone still use Gentoo? Maybe the same one is using Rub=
y) :-)
>         etc.
>
> - Windows
>         Download the installation package
>
> - You are a geek? Install from source! (here you can talk about dependenc=
ies and all that stuff)
>
> I know how to install it, that's not the point. I'm making the devil's ad=
vocate. If I'm a Mac OS X user, there is no way to know that I can install =
it from MacPorts unless reading the wiki. Maybe I just read the documentati=
on, and I can't find, in the doc, there is an image to install it. I want r=
ead the manual, I want navigate to the Install section, choose Mac OS X, an=
d learn all the ways to install it.
> The manual should teach you all, but it doesn't. I read it and I say: oh =
fuck, all those steps to install CouchDB on a *nix system?

Fair point, I got it. Thanks!

>> You got the point, but from the opposite side (: Content is moving
>> from wiki to docs in wiki is been deprecated in favour of docs.
>
> And this is good. But when the doc is updated with the wiki content, ther=
e is no reason to keep the same information there.

To keep there - you mean wiki? At this you're also right: once docs be
merged with master, wiki content have to redirect to docs for some
time before fade away.


> Just to be clear, I have nothing against you, I'm just suggesting some im=
provements because I think they can make a difference. In my opinion the do=
cumentation is fundamental.

No worries, moar critics and ideas! (: Thanks (:

P.S. I also will be glad if you take a look on query server protocol
and say what you think about:
http://kxepal.iriscouch.com/docs/1.3/query-server/protocol.html
As the developer of php query server I believe you have your own view about=
 (;

--
,,,^..^,,,