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 gs@redcometlabs.com designates
 209.85.212.171 as permitted sender)
Content-Type: text/plain; charset=iso-8859-1
Mime-Version: 1.0 (Mac OS X Mail 6.6 \(1510\))
Subject: Re: couchdb internals doc repo
From: Garren Smith <garren@apache.org>
In-Reply-To: 
 <CAPaJBx5O78_+PAhg6j+yJE9_XHiSu3nvU94=Sr9JGg_6s6eV1A@mail.gmail.com>
Date: Sun, 20 Oct 2013 16:01:03 +0200
Content-Transfer-Encoding: quoted-printable
Message-Id: <00026FD6-D9B8-4A93-9AA4-190FC0E10E41@apache.org>
References: 
 <CAJNb-9ojQ6KDrmAhBghMBvWPqgaomkQZ+D=vc_D-jpXbVp20uA@mail.gmail.com>
 <CAPaJBx4GNtPUWTanG4xYO1kg+ZsWD-HkO=2EAQ7RwrT9t=a0+Q@mail.gmail.com>
 <CAJNb-9o055C=_F0mehJt_RiK=HkZ9Q3QE6pmkvFHVoFRMYQhTw@mail.gmail.com>
 <CAPaJBx5O78_+PAhg6j+yJE9_XHiSu3nvU94=Sr9JGg_6s6eV1A@mail.gmail.com>
To: dev@couchdb.apache.org

Hi Benoit,

This is a great idea. I also think this should be in the docs. Many =
people will find it easy to access from there.

Cheers
Garren

On 20 Oct 2013, at 2:03 PM, Noah Slater <nslater@apache.org> wrote:

> I think if we're documenting CouchDB internals, and other dev topics
> relating to CouchDB, then it's fine for that stuff to live inside the
> CouchDB manual. We host it online, so people can access it without =
having
> to download CouchDB itself.
>=20
> Also, you can edit ReST directly from Github. So contributing should =
be as
> easy as forking your branch, and then editing the file in the Github
> interface itself. At least, I think that's how Alexander imagines =
people
> might contribute!
>=20
>=20
> On 20 October 2013 13:59, Benoit Chesneau <bchesneau@gmail.com> wrote:
>=20
>> On Sun, Oct 20, 2013 at 1:09 PM, Noah Slater <nslater@apache.org> =
wrote:
>>=20
>>> Benoit,
>>>=20
>>> Any way to get commit messages or notifications sent to the mailing =
list?
>>>=20
>>=20
>> was about to set it up.
>>=20
>>>=20
>>> As a community, we've promised to have all major activity happen on =
the
>>> mailing list. Usually, this would apply to code. But I think you =
could
>> say
>>> the same about the development documentation. If there is =
significant
>> work
>>> going on away from the mailing lists, we may have to do a full IP
>> Clearance
>>> when we want to merge it back.
>>>=20
>> How difficult would it be fore you to create a new branch for this? =
And
>>> while you're at it, create a new section in the manual that we ship =
under
>>> share/doc. A section for developers. Because we mirror to Github, =
you
>>> should still be able to invite PRs.
>>>=20
>>>=20
>>>=20
>> No difficulties really. I just felt like it, since no-one really took =
care
>> about it until now. (we talk about that many time even 2 years ago at =
the
>> summit).
>>=20
>> I can without difficulties (except having to convert it to this ugly
>> restructured text) moved it to a branch or even master. I just want =
to make
>> sure anyone is enough comfortable to work on a doc mixed with user =
things.
>> And by anyone I am thinking to people that work on couchdb =
alternatives.
>>=20
>> - benoit
>>=20
>>=20
>>>=20
>>> On 20 October 2013 12:32, Benoit Chesneau <bchesneau@gmail.com> =
wrote:
>>>=20
>>>> Hi all,
>>>>=20
>>>> It came to my mind that a some people are asking how the couchdb
>>> internals
>>>> are working. Some for implementing alternatives, some to start =
start to
>>>> hack on couchdb and others for pure curiosity.
>>>>=20
>>>> I have started a repository to collect the docs about it:
>>>>=20
>>>> https://github.com/benoitc/couchdb_internals
>>>>=20
>>>> For now it only contains the docs I have about the replication
>> algorithm.
>>>> If you want to join me in that effort, just open a PR. For those =
who
>> also
>>>> want direct commit access, then start with a pr with some content =
and
>> ask
>>>> for it. This is that simple.
>>>>=20
>>>> Things that will be accepted on that repo are:
>>>>=20
>>>> - docs
>>>> - corrections
>>>> - anything that can help to maintain and display such docs.
>>>>=20
>>>> Part of the docs could eventually be merged later in the couchdb
>>> repository
>>>> but I also think that having such repo outside can also be a good =
start
>>> for
>>>> a collaboration between many projects around and share new
>>>> ideas/implementations details.
>>>>=20
>>>>=20
>>>> Anyway will be on irc or on the ml if you want to discuss about it.
>>>>=20
>>>> Best,
>>>>=20
>>>> - benoit
>>>>=20
>>>=20
>>>=20
>>>=20
>>> --
>>> Noah Slater
>>> https://twitter.com/nslater
>>>=20
>>=20
>=20
>=20
>=20
> --=20
> Noah Slater
> https://twitter.com/nslater