On 03/11/2010 09:47 AM, Alan Conway wrote:
This is a great start, we really need proper versioned documentation.
The content definitely needs work to get it up to date and accurate,
and we should strip out remarks such as "in version 0.4" since this
doc should refers to the version it's in SVN with. It may also need
some re-org but that will probably come about as we rework the content.
I agree. And yes, it's a start.
I think the next step is probably to decide whether the rough
organization is good, and identify portions that need to be replaced,
portions that should be kept but improved, etc. To me, polishing the
presentation of the existing material "as is" may not be worth the effort.
I suggest that this book be strictly user documentation and we strip
out any design stuff that may have been imported from the wiki. We
need design docs also but they're separate. I'm currently thinking
that design docs belong closer to the source, e.g. in doxygen for C++.
I agree. And I tried to keep design docs mostly out of this.
I'll give the clustering content the once-over, may take me a week or
two though.
I think we can probably contribute better material on Clustering,
Federation, Persistence, Security, etc. based on other materials that we
have at Red Hat.
I also think we can write high level API tutorials in DocBook, perhaps
using some of the material in the Red Hat tutorials.
Anyone know any good open-source docbook WYSIWYG editing tools?
Editing the raw XML is a little unappealing :)
For the Emacs crowd, I like nxml-mode, especially if you learn how to
use tag completion, outlining, etc. (See
http://www.dpawson.co.uk/relaxng/nxml/info.html).
For vi folks, here's something I've seen but never tried:
http://www.linuxjournal.com/article/7737.
On Windows, I like Stylus Studio (http://www.stylusstudio.com/). On
Linux, I like Oxygen (http://www.oxygenxml.com/). Both are commercial
products.
Here's a page on authoring tools for DocBook:
http://wiki.docbook.org/topic/DocBookAuthoringTools
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscr...@qpid.apache.org
