On Thu, 29 Jun 2006, Heikki Toivonen wrote:
Andi Vajda wrote:
On Thu, 29 Jun 2006, Markku Mielityinen wrote:
documentation that there is in the source tree). I became interested
in the repository and its design so I tried to find as much
information about that as I could. The documents that I found
explained clearly how to use the repository in parcels but contained
less information about the actual design and implementation of the
repository. When I was unable to find a good document about that, I
Sorry, I don't have any hidden documentation. Another source of
I think it would be useful to have more information about the
repository. I seem to recall there was a general repository doc done
perhaps for 0.3...
Yes, it would be useful. The one I wrote during the 0.3 release cycle is now
pretty out of date and was deemed totally useless by John anyway.
I think the document should answer a few basic questions, and could be
pretty short, and written on a high enough level so that it does not
become obsolete in every release:
* What is the repository, a paragraph introduction
* Pretty high level requirements/goals, including performance targets
* What software modules does the repository consist of, with brief
explanation of how each is used
* Core concepts and objects (kinds, items, attributes, monitors,
watchers, views, ...)
Sounds great. Would you like to get it started ? Documents about some of the
topics you suggest are already available in various places such as the
chandlerdb blog, epydoc, or more or less obsolete documents on the wiki.
If someone volunteered to get it started and structured, I would definitely
review, edit and enhance it. The hardest part is with getting it started and
keeping it useful.
Andi..
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Open Source Applications Foundation "chandler-dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/chandler-dev
