Re: example of proton documentation

2013-02-26 Thread Alan Conway
This is a good start! We should start a proton book so this has a place to live. The Qpid books are in docbook under qpid/doc/book. I'm not a huge fan of docbook but probably best to stick with it unless there's something significantly better. A few comments on the content: On Fri, 2013-02-22 at

Re: example of proton documentation

2013-02-25 Thread Jakub Scholz
Hi Michael, I'm rather a foreigner in the land of Proton, but that point of view might make the feedback useful as well :-). As someone who didn't worked with proton much, I would probably raise following questions ... a) If I remember correctly, in (some of) the old Qpid APIs the flow control

example of proton documentation

2013-02-22 Thread Michael Goulish
I wonder if anybody out there in Proton Land has an opinion about this little piece of Proton doc. This is an example of the documentation I'm creating as I use the Proton interface to I'd be interested to hear about 1. correctness 2. clarity 3. focus 4.

Re: example of proton documentation

2013-02-22 Thread Phil Harvey
Hi Michael, Looks like a good start. Where are you intending to store this documentation? Similarly, where are you intending to publish it, e.g. as HTML and/or PDF on our web site, as a wiki page etc? I'm particularly interested in this topic because I'm focusing on the lower level Engine