Re: [ZODB-Dev] ZODB Documentation
On May 26, 2009, at 12:54 PM, Laurence Rowe wrote: A few weeks ago I converted the ZODB/ZEO Programming Guide and a few more articles into structured text and added them to the zope2docs buildout. I've now moved them to their own buildout in svn+ssh://svn.zope.org/repos/main/zodbdocs/trunk and they will soon appear at http://docs.zope.org/zodb (thanks Jens!) This means we now have two copies of the programming guide, one in latex in the ZODB sources and one in stx in zodbdocs. I'd like to propose removing the latex version and direct any changes to the stx version. +1 (I'd repressed knowledge of the latex version.) Jim -- Jim Fulton Zope Corporation ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
On 26.05.09 18:54, Laurence Rowe wrote: A few weeks ago I converted the ZODB/ZEO Programming Guide and a few more articles into structured text and added them to the zope2docs buildout. I've now moved them to their own buildout in svn+ssh://svn.zope.org/repos/main/zodbdocs/trunk and they will soon appear at http://docs.zope.org/zodb (thanks Jens!) There is also (the same=) ZODB documentation available under http://docs.zope.org/zope2/articles/ We should get rid of one copy. Andreas begin:vcard fn:Andreas Jung n:Jung;Andreas org:ZOPYX Ltd. Co. KG adr;quoted-printable:;;Charlottenstr. 37/1;T=C3=BCbingen;;72070;Germany email;internet:i...@zopyx.com title:CEO tel;work:+49-7071-793376 tel;fax:+49-7071-7936840 tel;home:+49-7071-793257 x-mozilla-html:FALSE url:www.zopyx.com version:2.1 end:vcard ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
On 26.05.09 19:08, Andreas Jung wrote: On 26.05.09 18:54, Laurence Rowe wrote: A few weeks ago I converted the ZODB/ZEO Programming Guide and a few more articles into structured text and added them to the zope2docs buildout. I've now moved them to their own buildout in svn+ssh://svn.zope.org/repos/main/zodbdocs/trunk and they will soon appear at http://docs.zope.org/zodb (thanks Jens!) There is also (the same=) ZODB documentation available under http://docs.zope.org/zope2/articles/ We should get rid of one copy. oppss..sorry, for misreading...just seen your checkins for moving the stuff. Andreas begin:vcard fn:Andreas Jung n:Jung;Andreas org:ZOPYX Ltd. Co. KG adr;quoted-printable:;;Charlottenstr. 37/1;T=C3=BCbingen;;72070;Germany email;internet:i...@zopyx.com title:CEO tel;work:+49-7071-793376 tel;fax:+49-7071-7936840 tel;home:+49-7071-793257 x-mozilla-html:FALSE url:www.zopyx.com version:2.1 end:vcard ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
Andreas Jung wrote: On 26.05.09 19:08, Andreas Jung wrote: On 26.05.09 18:54, Laurence Rowe wrote: A few weeks ago I converted the ZODB/ZEO Programming Guide and a few more articles into structured text and added them to the zope2docs buildout. I've now moved them to their own buildout in svn+ssh://svn.zope.org/repos/main/zodbdocs/trunk and they will soon appear at http://docs.zope.org/zodb (thanks Jens!) There is also (the same=) ZODB documentation available under http://docs.zope.org/zope2/articles/ We should get rid of one copy. oppss..sorry, for misreading...just seen your checkins for moving the stuff. They're actually copies at the moment, once Jens performs his magic I'll remove them from the Zope 2 buildout. Laurence ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
Jim Fulton wrote: On May 26, 2009, at 12:54 PM, Laurence Rowe wrote: A few weeks ago I converted the ZODB/ZEO Programming Guide and a few more articles into structured text and added them to the zope2docs buildout. I've now moved them to their own buildout in svn+ssh://svn.zope.org/repos/main/zodbdocs/trunk and they will soon appear at http://docs.zope.org/zodb (thanks Jens!) This means we now have two copies of the programming guide, one in latex in the ZODB sources and one in stx in zodbdocs. I'd like to propose removing the latex version and direct any changes to the stx version. +1 (I'd repressed knowledge of the latex version.) Done. Laurence ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
Would it be useful to have a document that starts detailing sections that are missing in ZODB/ZEO programming guide? i.e. - Blobs are not mentioned. - ZEO/Persistent disk cache not mentioned - xdb reference safetybelt - Documentation of various backend storages - Relstorage, Demostorage, Filestorage - MVCC is not mentioned - Persistence cache not described - savepoints vs. nested transaction - Diagnostic recipes (how to diagnosis your application) - Known Limitations How do you guys suggest we work on documentation? Would it be useful to come up with an outline of the target documentation? Then people could start filling in some details. Maybe Jim could then review instead of produce the documentation? cheers alan ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
Re: [ZODB-Dev] ZODB Documentation
On May 26, 2009, at 1:45 PM, Alan Runyan wrote: Would it be useful to have a document that starts detailing sections that are missing in ZODB/ZEO programming guide? I'd honestly rather start from scratch with something that is more oriented to users. Of course, I'd want it to be complete. i.e. - Blobs are not mentioned. - ZEO/Persistent disk cache not mentioned - xdb reference safetybelt - Documentation of various backend storages - Relstorage, Demostorage, Filestorage - MVCC is not mentioned - Persistence cache not described - savepoints vs. nested transaction - Diagnostic recipes (how to diagnosis your application) - Known Limitations How do you guys suggest we work on documentation? Would it be useful to come up with an outline of the target documentation? Then people could start filling in some details. Maybe Jim could then review instead of produce the documentation? I'd actually like to produce this documentation myself. I've already started something. It got pushed aside by another project, but I expect to get back to it soon. Jim -- Jim Fulton Zope Corporation ___ For more information about ZODB, see the ZODB Wiki: http://www.zope.org/Wikis/ZODB/ ZODB-Dev mailing list - ZODB-Dev@zope.org http://mail.zope.org/mailman/listinfo/zodb-dev
