Jonathan,
Here is my 2 cents :)
Positives and minor points
---------------------------------
1. I think the intro and the use of the Hello World examples is really nice.
2. I like the way the addressing is described using drain and spout.
3. In "Address Strings" I think we should put the complete syntax,
including the BNF (as described in the python file) - or maybe the BNF
can be in the appendix?
4. How about we describe the general addressing options before talking
about 0-10 specific mappings?
Presumably the address was designed with 1.0 in mind, so if we
restructure the docs properly it will make things easy for us and the
end users when we eventually get to 1.0
Note ** However for the "Example 1.1. Simple Address Strings" it's
fine to have the queue and exchange example there.
5. Extended Address Options - I dislike this heading. I don't think
create, assert..etc are extended options.
As I mentioned above, I believe it's best we describe the general
options and then the 0-10 mapping.
6. Messaging Properties - lets include the JMS message props as well.
I will try to get them to you soon.
And then under separate heading we can show the 0-10 mapping for
the message props.
7. "Apache Qpid JNDI Properties for AMQP Messaging" should probably be
under JMS client as it's only relevant for that.
Also there are quite a bit of props now and let me get all that
info for you.
Perhaps this can be an appendix?
Really minor points, but annoying if not fixed
-----------------------------------------------------
1. The doc should have numbering
2. The overall structure doesn't seem well organized. (I will write
separate email on this when I have a chance to organize my thoughts).
Major points that I think is lacking
------------------------------------------
** This is not a criticism of the work you have done. I appreciate
the fact that for some of the points below you don't have the required
material yet.
But I like to see them eventually and I will contribute with what I know/can **
1. The tutorial doesn't really go beyond the basics (apart from addressing).
Is this the intention? I believe it shouldn't be.
2. Critical pieces that are missing
** Please note, you don't need complete runnable pieces of code to
illustrate the following. If we try to couple the tutorial to
examples, then we will end up limiting both**
Also some of the points below should be described in detail in a
user guide. But how to run them with an existing example is best
tackled via tutorial.
* How to do common messaging patterns (store-&-forward, pub/sub,
request/reply).
* How to do flow control
* Failover
* Transactions
* map messages (nested lists/maps - I don't think u need a
separate runnable example. This is pure code that and not really qpid
specific either)
* SSL (atleast point to something and maybe have a canned script
to run the hello world with one.)
* Authentication (describe the theory and then how the hello world
can be run with different auth mechs/options)
* ACL (I will do this for you - again not an example on it's own
nor a complete description.).
* Encryption.
* Transactions (not sure about this).
Sorry about the long list, neither do I claim this as an exhaustive list.
I am also very open to suggestions.
I think if we get this right, we can improve the end user experience
tremendously.
Regards,
Rajith
On Mon, Apr 19, 2010 at 10:29 AM, Jonathan Robie
<[email protected]> wrote:
> On 04/17/2010 02:07 PM, Marnie McCormack wrote:
>>
>> I had a read over the Java JMS section and think that it's useful and laid
>> out very nicely for the reader.
>>
>
> Thanks!
>
>> I think it possibly better labelled as 'for the C++ broker' since the bulk
>> of the setup details only apply to C++. I'd hope we'll get some time on
>> the
>> Java broker side to contribute to the docs/examples shortly so we can
>> flesh
>> out the same for the JB.
>>
>
> By the time we release 0.7. I'd really like to see both brokers work the
> same way for the simple command-line utilities like qpid-config, for the
> Qpid Messaging API, and for Java JMS applications using JNDI and the new
> addressing scheme.
>
> I'd much prefer that to having two separate tutorials. I think anything that
> requires us to have two separate tutorials is probably an indication that
> we're not doing a good enough job of working together as one coherent
> project.
>
>> The code example is good and simple, comments would be even better.
>>
>
> Thanks - I'll add some to the Java JMS example, am I being overly optimistic
> in thinking that the C++ and Python examples can be understood relatively
> easily without comments?
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:[email protected]
>
>
--
Regards,
Rajith Attapattu
Red Hat
http://rajith.2rlabs.com/
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
