On 09/24/2010 01:18 PM, Brian Aker wrote: > Hi! > > So the wiki really doesn't seem to be working for documentation. It > lacks comments, which are super useful, and it is just one big long > list. > > A few thoughts: 1) Docbook sucks to write in. 2) I personally would > be far more inclined to write via bzr (and have it shipped with the > code). 3) Doxygen is not for user level documentation. > > I've had a couple of folks who have been willing to work on this, but > the above pretty much means nothings happens. If I start writing on > this it will be POD (human editable, has tools, etc...). YAML would > be fine as well, but the layout for it is sort of odd. > > None of this solves the comment problem. PG's documentation seems ok, > as does MySQL's.
Done. In the tree already. :) (I took your note from the last meeting that someone needed to step up to the plate and put something in place) I've got Sphinx in and integrated with the build system. It's the system python and openstack both use for their docs - handles generating HTML, manpages and LaTeX/PDF docs ... and it's reStructuredText, which means anyone who knows how to write wiki pages can write docs in Sphinx. Lee and I also have a todo list task to get hudson to publish the docs with each push - I have this working in the openstack hudson already. http://sphinx.pocoo.org/ I'm working on adding docs on the command line option processing, and LinuxJedi is adding docs on the new drizzledump. As we move forward, it should be very easy for folks to add new documentation - even if they aren't devs. As a side note, thumper has been working on a piece of bzr-integrated wikki software called wikkid, which uses the same reStructuredText markup - so as soon as that's ready to go we can have a through-the-web documentation editing system that will feed back into the bzr branch for us. See - I get things done even before you ask for them! :) Monty _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
