couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jan Lehnardt <...@apache.org>
Subject Re: couchdb internals doc repo
Date Thu, 24 Oct 2013 13:22:00 GMT
+1 too, I’ve wanted to start this for a while, thanks for taking the initiative Benoit!

Best
Jan
--

On 20 Oct 2013, at 16:39 , Alexander Shorin <kxepal@gmail.com> wrote:

> +1 to have this information in docs. One good docs to describe all the couch! (:
> 
> P.S. I'll submit new replication protocol definition for review a bit
> later today.
> --
> ,,,^..^,,,
> 
> 
> On Sun, Oct 20, 2013 at 6:01 PM, Garren Smith <garren@apache.org> wrote:
>> 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.
>>> 
>>> 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!
>>> 
>>> 
>>> On 20 October 2013 13:59, Benoit Chesneau <bchesneau@gmail.com> wrote:
>>> 
>>>> On Sun, Oct 20, 2013 at 1:09 PM, Noah Slater <nslater@apache.org> wrote:
>>>> 
>>>>> Benoit,
>>>>> 
>>>>> Any way to get commit messages or notifications sent to the mailing list?
>>>>> 
>>>> 
>>>> was about to set it up.
>>>> 
>>>>> 
>>>>> 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.
>>>>> 
>>>> 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.
>>>>> 
>>>>> 
>>>>> 
>>>> 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).
>>>> 
>>>> 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.
>>>> 
>>>> - benoit
>>>> 
>>>> 
>>>>> 
>>>>> On 20 October 2013 12:32, Benoit Chesneau <bchesneau@gmail.com>
wrote:
>>>>> 
>>>>>> Hi all,
>>>>>> 
>>>>>> 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.
>>>>>> 
>>>>>> I have started a repository to collect the docs about it:
>>>>>> 
>>>>>> https://github.com/benoitc/couchdb_internals
>>>>>> 
>>>>>> 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.
>>>>>> 
>>>>>> Things that will be accepted on that repo are:
>>>>>> 
>>>>>> - docs
>>>>>> - corrections
>>>>>> - anything that can help to maintain and display such docs.
>>>>>> 
>>>>>> 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.
>>>>>> 
>>>>>> 
>>>>>> Anyway will be on irc or on the ml if you want to discuss about it.
>>>>>> 
>>>>>> Best,
>>>>>> 
>>>>>> - benoit
>>>>>> 
>>>>> 
>>>>> 
>>>>> 
>>>>> --
>>>>> Noah Slater
>>>>> https://twitter.com/nslater
>>>>> 
>>>> 
>>> 
>>> 
>>> 
>>> --
>>> Noah Slater
>>> https://twitter.com/nslater
>> 


Mime
View raw message