[Zope-dev] Zope internals documentation

[Martin Aspeli]

On 1 January 2012 10:51, Andreas Jung <lists at zopyx.com> wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
>
>
> Martin Aspeli wrote:
>> On 1 January 2012 10:43, Jens Vagelpohl <jens at dataflake.org> wrote:
>>> Hi Martin,
>>>
>>>>> There *is* a better place, docs.zope.org. If you can tell me
>>>>> where the sources are I can put it there.
>>>> Sure: Clone
>>>> https://github.com/collective/collective.developermanual/ and get
>>>> it from source/zope_secrets.
>>> Thanks, I'll take a look at it today.
>>>
>>>
>>>> Where is docs.zope.org maintained?
>>> On one of the ZF servers.
>>
>> If it's going to go there, I'd like it to (a) be in version control
>> and (b) be somewhere that I can edit it. Is that doable?
>
> Wouldn't it make sense to integrate your docs with The Zope Book.
> It's maintained using Sphinx and the sources are on svn.zope.org
> (somewhere).

This is really low level documentation. The Zope Book is for people
using Zope. This is for people who may need to maintain or deep-debug
it.

I'm happy for it to be integrated if people think it makes sense, but
I think it may be quite off-putting to read what is in many places
block-by-block explanations of what the code does.

Martin