On May 21, 2013, at 17:25 , Noah Slater wrote:
> I think the idea of a "Developer Handbook" is a good one.
> That's separate from a "CouchDB Manual" though.
I’m roughly modelling this after the FreeBSD project which has
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/
(this corresponds to our “docs/”)
and
http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/
(and a few more).
So they have separate handbooks for this, and I think eventually that
makes sense for us as well, but I thought it was easiest to get started
with the developer handbook as a chapter/section in our docs/ until it
is substantial enough to make into its own.
> For now, let's focus on getting the manual up to scratch, and let's keep
> the handbook stuff on the wiki.
>
> We can re-evaluate the situation later. I'm not married to it. :)
I want to start this asap because we have some thing flying around
elsewhere that would benefit from getting into a definite location.
Note though that Release_Procedure, while totally applicable to a
developer handbook, doesn’t have to migrate today if you prefer that.
If so, I’d suggest we just put a link into the developer handbook that
points to the wiki.
Does that make sense?
Jan
--
>
>
>
> On 21 May 2013 16:00, Jan Lehnardt wrote:
>
>>
>> On May 21, 2013, at 15:27 , Noah Slater wrote:
>>
>>> Actually, I prefer that project documentation be kept on the wiki.
>>>
>>> The docs that we have in the source are the "CouchDB Manual" (as I
>>> have titled it), and I see them as a reference work for CouchDB itself.
>>> Setting it up, configuring it, using it, etc.
>>>
>>> I see the wiki as more a place for the project / community to document
>> and
>>> organise itself. Consider that our homepage is a single HTML page. Most
>> of
>>> what we'd usually have on a website was moved to the wiki. So, I'm
>> talking
>>> release process, release calendar, source locations, active releases,
>>> committer election process, PMC election process, and soon, by-laws,
>>> community guides, etc.
>>>
>>> I'd like to keep this stuff on the wiki for now.
>>
>> I want to start a section in there that is called “The Developer Handbook”.
>> The release docs would fit right in there, but this is your call
>> ultimately,
>> maybe we can have a pointer to the wiki from the docs/ then?
>>
>> Jan
>> --
>>
>>
>>
>>
>>>
>>>
>>> On 21 May 2013 13:20, Jan Lehnardt wrote:
>>>
>>>> On 21.05.2013, at 11:37, Dirkjan Ochtman wrote:
>>>>
>>>>> On Tue, May 21, 2013 at 11:33 AM, Jan Lehnardt wrote:
>>>>>> It is all documented here:
>>>> http://wiki.apache.org/couchdb/Release_Procedure
>>>>>
>>>>> Oh, good. We should definitely pull stuff like that into a developer
>>>>> chapter of the docs, IMO.
>>>>
>>>> Go for it :)
>>>>
>>>> I think we have a rough consensus on moving most of the wiki into the
>>>> docs. Anyone, feel free to act on this!
>>>>
>>>> Jan
>>>> --
>>>>
>>>>
>>>
>>>
>>> --
>>> NS
>>
>>
>
>
> --
> NS