First up good job jonathan ! I think we can start from here and improve it gradually.
As Alan said we should strip out any design docs etc.. I will also have a look and try organize the java client side as much as I can. Joanthan would you like to send an email outlining how the docs are currently organized and how we may want the end product to look? Perhaps then people can keep that in mind when they do the updates or new addition of content. On Thu, Mar 11, 2010 at 9:47 AM, Alan Conway <acon...@redhat.com> wrote: > On 03/11/2010 09:31 AM, Jonathan Robie wrote: >> >> Here's a PDF built from the Qpid Wiki, converted to DocBook: >> >> http://people.apache.org/~jonathan/qpid-book.pdf >> >> I'm posting this now as a sign of life, to give a feel for where this is >> headed, and to get feedback on the organization. >> >> There are some things that still need cleaning up: >> >> - some links don't resolve properly >> - some formatting issues >> - some pages have been updated since I converted them >> >> But some of this should simply be replaced with new content - I have >> some existing content that we can contribute, and I'd like to start >> creating new content here, instead of or in addition to the Wiki. >> >> I'd also like to get some other people working on this with me. I'd >> particularly like to get someone to be in charge of the section on the >> Java Broker. >> >> Who wants to get involved in this? >> > > 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 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'll give the clustering content the once-over, may take me a week or two > though. > > Anyone know any good open-source docbook WYSIWYG editing tools? Editing the > raw XML is a little unappealing :) > > --------------------------------------------------------------------- > Apache Qpid - AMQP Messaging Implementation > Project: http://qpid.apache.org > Use/Interact: mailto:dev-subscr...@qpid.apache.org > > -- Regards, Rajith Attapattu Red Hat http://rajith.2rlabs.com/ --------------------------------------------------------------------- Apache Qpid - AMQP Messaging Implementation Project: http://qpid.apache.org Use/Interact: mailto:dev-subscr...@qpid.apache.org
