Senaka Fernando wrote:
Hi all,
According to the present discussion, I think it would be best to wait a bit
until Jonathan can come to an agreement about how the example documentation
could be made use in Qpid. However, there are certain other areas in which I
can start work on, some that Jonathan's docs don't focus.
Great! (Sorry I'm responding so slowly, I left Friday evening for a
backpacking trip.)
1. How to run the examples. I mean the order.
It is important that we describe the order in which the constitutes of
each example must be run, and the reason behind it. It should also detail
the results seen on the broker side (explanation on the trace logs), and
also something similar on the client side. This raises a new question. How I
can I enable trace logs on the client side?
Yes, I think READMEs on this would be really helpful.
2. Some docs on the RedHat site are not quite right, and not quite complete.
I'm not attempting to point them on this list, as I don't know the legality
of such a statement. Thus, I would like to talk in person to anyone
responsible on those documentation, on behalf of Qpid, should there be any
need.
I'm responsible for these, I'd be glad to talk to you or you can send me
email. I work out of the office some days and at home others, if you
shoot me an email I can call you or tell you where to call me.
3. We need to create a README per example, at least a tiny one. People
wouldn't otherwise have a clue when the try it for the first time. I can get
going on this now.
Great!
4. And, as Danushka stated, +1 for including these to the docs. I mean the
docs found inside the docs folder.
I agree.
5. Also, I need to know where on the wiki I should start writing
documentation on examples. I didn't get an answer to that as yet.
Someone else will have to answer this.
6. It would be better to include a 'help' message for the verify_all, and
verify scripts. Until I asked this question on the list, I didn't have a
clue on what arguments that could be provided.
Agreed.
Jonathan
