You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by Jonathan Robie <jo...@redhat.com> on 2010/03/16 15:18:03 UTC
Qpid docs - file structure and organization
I'd like feedback on the overall file structure and organization of the
Qpid DocBook docs - is this a structure we feel comfortable adding to?
Does it need to be changed in any way? I'd like to get that part right
first.
Here is the table of contents:
Table of Contents
I. Basics
............................................................................................................................
1
1. Apache Qpid: Open Source AMQP Messaging
............................................................. 3
AMQP Messaging Brokers
...................................................................................
3
AMQP Client APIs: C++, Java, JMS, Ruby, Python, and C#
...................................... 3
Operating Systems and Platforms:
......................................................................... 3
2. AMQP (Advanced Message Queueing Protocol
............................................................ 5
Download the AMQP Specifications
...................................................................... 5
3. Getting Started
.......................................................................................................
7
4. Download Apache Qpid
...........................................................................................
9
Production Releases
............................................................................................
9
0.5 Release
........................................................................................................
9
Multiple Component Packages
...................................................................... 9
Single Component Package
.......................................................................... 9
QpidComponents.org
.........................................................................................
10
Contributed C++ Packages
.................................................................................
11
Pre-built Linux Packages
............................................................................
11
Windows Installer
.....................................................................................
11
Source Code Repository
.....................................................................................
11
II. AMQP Messaging Broker (Implemented in C++)
............................................................... 12
5. Running the AMQP Messaging Broker
.................................................................... 13
Running a Qpid C++ Broker
............................................................................
13
Building the C++ Broker and Client Libraries
.............................................. 13
Running the C++ Broker
..........................................................................
13
Most common questions getting qpidd running
............................................. 13
Authentication
........................................................................................
14
Slightly more complex configuration
.......................................................... 15
Loading extra modules
............................................................................
16
Cheat Sheet for configuring Queue Options
......................................................... 17
Configuring Queue Options
...................................................................... 17
Cheat Sheet for configuring Exchange Options
..................................................... 19
Configuring Exchange Options
.................................................................. 19
Using Broker Federation
..................................................................................
21
Introduction
...........................................................................................
21
What Is Broker Federation?
...................................................................... 21
The qpid-route Utility
..............................................................................
21
Example Scenarios
..................................................................................
27
Advanced Topics
....................................................................................
29
SSL
..............................................................................................................
29
SSL How to
..........................................................................................
29
LVQ
............................................................................................................
31
Understanding LVQ
................................................................................
31
LVQ semantics:
.....................................................................................
31
LVQ_NO_BROWSE semantics:
................................................................ 32
Example source
......................................................................................
33
queue state replication
.....................................................................................
36
Asynchronous Replication of Queue State
................................................... 36
Starting a cluster
............................................................................................
40
Running a Qpidd cluster
..........................................................................
40
ACL
.............................................................................................................
42
v2 ACL file format for brokers
................................................................. 42
Design Documentation
.............................................................................
45
v2 ACL User Guide
................................................................................
46
6. Managing the AMQP Messaging Broker
.................................................................. 48
Managing the C++ Broker
................................................................................
48
Using qpid-config
...................................................................................
48
Using qpid-route
.....................................................................................
50
Using qpid-tool
......................................................................................
51
Using qpid-printevents
.............................................................................
55
QMan - Qpid Management bridge
..................................................................... 55
QMan : Qpid Management Bridge
............................................................. 55
Qpid Management Framework
..........................................................................
56
What Is QMF
........................................................................................
56
Getting Started with QMF
........................................................................ 57
QMF Concepts
.......................................................................................
57
The QMF Protocol
..................................................................................
61
How to Write a QMF Console
.................................................................. 61
How to Write a QMF Agent
..................................................................... 61
Management Design notes
................................................................................
61
Status of This Document
..........................................................................
61
Introduction
...........................................................................................
62
Links
....................................................................................................
62
Management Requirements
....................................................................... 62
Definition of Terms
................................................................................
63
Operational Scenarios: Basic vs. Extended
................................................... 63
Architectural Framework
..........................................................................
63
The Management Exchange
...................................................................... 64
The Protocol
..........................................................................................
65
QMF Python Console Tutorial
..........................................................................
79
Prerequisite - Install Qpid Messaging
......................................................... 79
Synchronous Console Operations
............................................................... 79
Asynchronous Console Operations
............................................................. 84
Discovering what Kinds of Objects are Available
.......................................... 88
III. AMQP Messaging Broker (Implemented in Java)
.............................................................. 89
7. General User Guides
..............................................................................................
90
Java Broker Feature Guide
...............................................................................
90
The Qpid pure Java broker currently supports the
following features: ................ 90
Qpid Java FAQ
..............................................................................................
90
Purpose
...................................................................................................
90
Java Environment Variables
............................................................................
100
Setting Qpid Environment Variables
......................................................... 100
Qpid Troubleshooting Guide
...........................................................................
100
I'm getting a java.lang.UnsupportedClassVersionError
when I try to start the
broker. What does this mean ?
.................................................................. 100
I'm having a problem binding to the required host:port
at broker startup ? ......... 101
I'm having problems with my classpath. How can I
ensure that my classpath is
ok ?
.....................................................................................................
101
I can't get the broker to start. How can I diagnose
the problem ? ..................... 101
When I try to send messages to a queue I'm getting a
error as the queue does not
exist. What can I do ?
.............................................................................
101
8. How Tos
............................................................................................................
102
Add New Users
............................................................................................
102
Available Password file formats
............................................................... 102
Dynamic changes to password files.
......................................................... 103
How password files and PrincipalDatabases relate to
authentication
mechanisms
..........................................................................................
104
Configure ACLs
...........................................................................................
104
Configure ACLs
...................................................................................
104
Configure Java Qpid to use a SSL connection.
.................................................... 104
Using SSL connection with Qpid Java.
...................................................... 104
Setup
..................................................................................................
104
Performing the connection.
..................................................................... 105
Configure Log4j CompositeRolling Appender
.................................................... 105
How to configure the CompositeRolling log4j Appender
............................... 105
Configure the Broker via config.xml
................................................................. 107
Broker config.xml Overview
................................................................... 107
Qpid Version
.......................................................................................
107
Configure the Virtual Hosts via virtualhosts.xml
................................................. 107
virtualhosts.xml Overview
...................................................................... 107
Debug using log4j
.........................................................................................
109
Debugging with log4j configurations
........................................................ 109
How to Tune M3 Java Broker Performance
....................................................... 113
Problem Statement
................................................................................
113
Successful Tuning Options
..................................................................... 113
Next Steps
...........................................................................................
114
Qpid Java Build How To
...............................................................................
114
Build Instructions - General
.................................................................... 114
Build Instructions - Trunk
...................................................................... 115
Use Priority Queues
......................................................................................
118
General Information
..............................................................................
118
Defining Priority Queues
........................................................................ 118
Client configuration/messaging model for priority queues
............................. 119
9. Qpid JMX Management Console
...........................................................................
120
Qpid JMX Management Console
..................................................................... 120
Overview
.............................................................................................
120
10. Management Tools
.............................................................................................
135
MessageStore Tool
........................................................................................
135
MessageStore Tool
................................................................................
135
Qpid Java Broker Management CLI
................................................................. 136
How to build Apache Qpid CLI
............................................................... 136
IV. AMQP Messaging Clients Clients
.................................................................................
138
11. AMQP Java JMS Messaging Client
...................................................................... 140
General User Guides
........................................................................................
140
System Properties
.................................................................................
140
Connection URL Format
........................................................................ 143
Binding URL Format
.............................................................................
145
AMQP Java JMS Examples
.............................................................................
147
12. AMQP C++ Messaging Client
.............................................................................
148
User Guides
.................................................................................................
148
Examples
.....................................................................................................
148
13. AMQP .NET Messaging Client
...........................................................................
149
User Guides
.................................................................................................
149
Apache Qpid: Open Source AMQP Messaging - .NET User
Guide .................. 149
Excel AddIn
.........................................................................................
164
WCF
..................................................................................................
166
Examples
.....................................................................................................
167
14. AMQP Python Messaging Client
......................................................................... 168
User Guides
.................................................................................................
168
Examples
.....................................................................................................
168
PythonBrokerTest
.........................................................................................
168
Python Broker System Test Suite
............................................................. 168
15. AMQP Ruby Messaging Client
...........................................................................
169
Examples
.....................................................................................................
169
V. Appendices
................................................................................................................
170
16. AMQP compatibility
.........................................................................................
172
AMQP Compatibility of Qpid releases:
............................................................. 172
Interop table by AMQP specification version
..................................................... 173
17. Qpid Interoperability Documentation
.................................................................... 174
Qpid Interoperability Documentation
................................................................ 174
SASL
..................................................................................................
174
The table of contents is built, bottom up, from the files. Here is the
file structure:
Book.xml
Book-Info.xml
Introduction.xml
AMQP.xml
Getting-Started.xml
Download.xml
AMQP-Messaging-Broker-CPP.xml
Running-CPP-Broker.xml
Cheat-Sheet-for-configuring-Queue-Options.xml
Cheat-Sheet-for-configuring-Exchange-Options.xml
Using-Broker-Federation.xml
SSL.xml
LVQ.xml
queue-state-replication.xml
Starting-a-cluster.xml
ACL.xml
Managing-CPP-Broker.xml
QMan-Qpid-Management-bridge.xml
Qpid-Management-Framework.xml
Management-Design-notes.xml
QMF-Python-Console-Tutorial.xml
AMQP-Messaging-Broker-Java.xml
Java-Broker-Feature-Guide.xml
Qpid-Java-FAQ.xml
Java-Environment-Variables.xml
Qpid-Troubleshooting-Guide.xml
Add-New-Users.xml
Configure-ACLs.xml
Configure-Java-Qpid-to-use-a-SSL-connection.xml
Configure-Log4j-CompositeRolling-Appender.xml
Configure-the-Broker-via-config.xml.xml
Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
Debug-using-log4j.xml
How-to-Tune-M3-Java-Broker-Performance.xml
Qpid-Java-Build-How-To.xml
Use-Priority-Queues.xml
Qpid-JMX-Management-Console.xml
Configuring-Management-Users.xml
Configuring-Qpid-JMX-Management-Console.xml
Management-Console-Security.xml
Qpid-JMX-Management-Console-FAQ.xml
Qpid-JMX-Management-Console-User-Guide.xml
Qpid-Management-Features.xml
MessageStore-Tool.xml
Qpid-Java-Broker-Management-CLI.xml
AMQP-Java-JMS-Messaging-Client.xml
System-Properties.xml
Connection-URL-Format.xml
Binding-URL-Format.xml
AMQP-C++-Messaging-Client.xml
AMQP-.NET-Messaging-Client.xml
NET-User-Guide.xml
Excel-AddIn.xml
WCF.xml
AMQP-Python-Messaging-Client.xml
PythonBrokerTest.xml
AMQP-Ruby-Messaging-Client.xml
AMQP-Compatibility.xml
Qpid-Interoperability-Documentation.xml
Does this organization work?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
RE: Qpid docs - file structure and organization
Posted by Robbie Gemmell <ro...@gmail.com>.
> -----Original Message-----
> From: Rajith Attapattu [mailto:rajith77@gmail.com]
> Sent: 16 March 2010 15:56
> To: dev@qpid.apache.org
> Subject: Re: Qpid docs - file structure and organization
>
> On Tue, Mar 16, 2010 at 11:37 AM, Jonathan Robie
> <jo...@redhat.com> wrote:
> > On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
> >>
<snip>
>
> >
> >> III. AMQP Messaging Broker Management.
> >> This should be a top level section on it's own rather than
> >> anything that C++/Java broker specific. A majority of these tools
> can
> >> be used against both.
> >> We should state that our brokers can be managed using QMF (and
> JMX
> >> - the Java broker directly and the C++ broker via QMan).
> >>
> >> Chapter 1. Python management tools - (qpid-config,......)
> >> Chapter 2. QMan.
> >> QMF-to-JMX bridge
> >> QMF-to-WSDM bridge
> >> Chapter 3. Eclipse pluggins
> >>
> >
> >
> > OK. Any volunteers for the Qman and Eclipse sections?
>
> Hopefully I can get the QMan code working again and perhaps contribute
> to the docs.
>
</snip>
QMan already has a fair bit of documentation on the wiki. I tried it out for
0.6 around RC3 or so and found a few things that seemed they could do with
updating. I sent a mail about it at the time, but it doesn't appear Andrea
has time attend to them. Can't remember the exact details, but you can look
for the mail if you are interested :)
The JMX Management Console is fully documented, so other than maybe needing
some tweaks to make it fit the DocBook layout better it should be pretty
much done already. I'll happily attend to that (at some point). Although it
is Eclipse RCP based, it isn't intended for use within the Eclipse IDE (and
has never been tested that way in its current form, plus didn't play that
nicely in previous iterations) so I intend to rename that module in the repo
and eradicate mentions of 'eclipse-plugin' at some point as it isn't really
one :)
Robbie
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Alan Conway <ac...@redhat.com>.
On 03/16/2010 03:07 PM, Jonathan Robie wrote:
> On 03/16/2010 01:29 PM, Alan Conway wrote:
>>
>> The book is inherently tied to a qpid release by the fact that it is
>> versioned in subversion. It should pick up the release number from the
>> build system automatically. I can hack up a Makefile.am and
>> CMakeLists.txt to build the book and generate an XML fragment with the
>> version in it - what should that XML fragment look like?
>
> I'm writing an ant file to build documents. Can you call that from your
> cmake?
>
Yes, can do if need be. I was forgetting that the book is not in the C++ build
system so the argument for using clearmake/automake is not very strong. Ant is
probably a more natural choice. I do think we should automate picking up the
version number from a central place but as of right now there is no such place
so hand coding it is no worse than what we do in all the other parts of the project.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 03/16/2010 01:29 PM, Alan Conway wrote:
>
> The book is inherently tied to a qpid release by the fact that it is
> versioned in subversion. It should pick up the release number from the
> build system automatically. I can hack up a Makefile.am and
> CMakeLists.txt to build the book and generate an XML fragment with the
> version in it - what should that XML fragment look like?
I'm writing an ant file to build documents. Can you call that from your
cmake?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Alan Conway <ac...@redhat.com>.
On 03/16/2010 11:55 AM, Rajith Attapattu wrote:
> On Tue, Mar 16, 2010 at 11:37 AM, Jonathan Robie
> <jo...@redhat.com> wrote:
>> On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
>>>
>>> Here are some general comments.
>>> Frankly I am not too happy with the current format.
>>>
>>
>> That's fine - the current format was created in order to use existing Wiki
>> pages with as little modification as possible, with enough organization for
>> the sake of sanity.
>
> My comments were about the existing format rather than the work you had done.
> I think you have done excellent work in getting this off the ground !
> I was aware that the first step was to get everything exported and
> then take it from there.
> I just wanted to make sure I sound my concerns early and decisively
> before we move forward.
>
>> I want to know where we are heading, and move in that direction, rather than
>> polish what we have before setting goals. The most important thing right now
>> is to establish a common direction.
>>
>>> I'd like to see the following in the docs.
>>>
>>> 1. The user guide should be tied to a particular version, as we are
>>> shipping them for each release.
>>>
>>
>> Absolutely. And I think we need to start by setting a goal here. I propopose
>> that we aim to have up-to-date docs for release 7 - I can put the release
>> number on the front page.
The book is inherently tied to a qpid release by the fact that it is versioned
in subversion. It should pick up the release number from the build system
automatically. I can hack up a Makefile.am and CMakeLists.txt to build the book
and generate an XML fragment with the version in it - what should that XML
fragment look like?
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Rajith Attapattu <ra...@gmail.com>.
On Tue, Mar 16, 2010 at 11:37 AM, Jonathan Robie
<jo...@redhat.com> wrote:
> On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
>>
>> Here are some general comments.
>> Frankly I am not too happy with the current format.
>>
>
> That's fine - the current format was created in order to use existing Wiki
> pages with as little modification as possible, with enough organization for
> the sake of sanity.
My comments were about the existing format rather than the work you had done.
I think you have done excellent work in getting this off the ground !
I was aware that the first step was to get everything exported and
then take it from there.
I just wanted to make sure I sound my concerns early and decisively
before we move forward.
> I want to know where we are heading, and move in that direction, rather than
> polish what we have before setting goals. The most important thing right now
> is to establish a common direction.
>
>> I'd like to see the following in the docs.
>>
>> 1. The user guide should be tied to a particular version, as we are
>> shipping them for each release.
>>
>
> Absolutely. And I think we need to start by setting a goal here. I propopose
> that we aim to have up-to-date docs for release 7 - I can put the release
> number on the front page.
The 0.7 release is a reasonable goal.
> Currently, we have a hodge-podge of docs corresponding to different
> versions, and for some of this material I simply don't know what versions it
> corresponds to.
>
>> 2. The guide should focus on end users, not developers. So we should
>> get rid of all design docs.
>>
>
>
> Agreed.
>
>
>> 3. Our documentation should reflect the goals, vision and direction of
>> the project.
>>
>> a) Brokers with a common set of features
>> b) Management tools that work with both brokers
>> c) Common Client API's
>> d) Interoperability via examples
>>
>
>
> OK.
>
>> 4. I would like to see the TOC as follows.
>>
>> I. Introduction
>> What you have here is fine, but I am not sure about the getting
>> started and download stuff. I need to think about it a bit more.
>>
>
> OK.
>
> I think the goal of the introduction should be:
>
> 1. To introduce the most important concepts briefly
> 2. To show the user how to get up and running, to the point of being able to
> run an example.
Agreed and a large part of this will depend on the examples as well.
In an earlier email Rafi talked about creating a bundle, which
contains a broker, clients, mgt tools and examples.
If we get there, then the getting started guide should be simple in
that you just need to untar it (or install if using rpms) and then run
the examples using the README.
>
>> II. AMQP Messaging Brokers
>> I think rather than having separate sections for each broker, it's
>> best to describe common functionality first then we can have separate
>> chapters for each broker.
>> Recently Rob Godfrey has done a tremendous amount of work to bring
>> the Java broker inline with the c++ broker in terms of features.
>> Ex. Federation, QMF support, LVQ etc... (in addition common
>> features include ACL, Authentication, SSL ..etc)
>>
>> So perhaps the section can be organized as,
>> Chapter 1. Broker concepts (Federation, Security {ACL,
>> Authentication, SSL}, QMF, LVQ ..etc)
>> Chapter 2. Java Broker
>> Chapter 3. C++ Broker
>> (Chapters 2&3 describes the specifics like how to install, run, and
>> configure)
>>
>
>
> This makes sense - I have not been following the Java Broker, I didn't know
> how much progress had been made. Cool!
>
>
>> II. AMQP Messaging Clients
>> We should again explain the common concepts and vision behind the
>> client API's while stating that JMS and WCF are following idioms/API's
>> that are already defined for those domains.
>> The specific chapters on each client will focus on the languages
>> specific items like (how to open a connection, receive a message, send
>> a message ..etc) and the relevant configuration options.
>>
>> Chapter 1. API and addressing syntax.
>> Chapter 2. Python Client
>> Chapter 3. C++ Client
>> Chapter 4. JMS Client
>> Chapter 5. WCF Client
>> Chapter 6. Ruby Client
>>
>
>
> Good. I assume that we will use the high level APIs in all this.
Yes for sure.
I believe the Ruby client will eventually get there as well.
WCF and JMS already has it's own standards based API for the respective domains.
>
>> III. AMQP Messaging Broker Management.
>> This should be a top level section on it's own rather than
>> anything that C++/Java broker specific. A majority of these tools can
>> be used against both.
>> We should state that our brokers can be managed using QMF (and JMX
>> - the Java broker directly and the C++ broker via QMan).
>>
>> Chapter 1. Python management tools - (qpid-config,......)
>> Chapter 2. QMan.
>> QMF-to-JMX bridge
>> QMF-to-WSDM bridge
>> Chapter 3. Eclipse pluggins
>>
>
>
> OK. Any volunteers for the Qman and Eclipse sections?
Hopefully I can get the QMan code working again and perhaps contribute
to the docs.
>
>> IV. QMF
>> This is actually a sub project of Qpid that can be used to manage
>> anything. So IMO it deserves it's own section.
>>
>> Chapter 1. QMF Concepts
>> Chapter 2. QMF C++ API
>> Chapter 2. QMF Python API
>> Chapter 4. QMF Java API
>>
>
> OK
Is this agreeable to you? Lets also see what other folks think
>> V. Testing Frameworks and Tools
>> Here we can talk about our testing frameworks and perf tools
>>
>
> Makes sense.
>
>> VI. Examples/Tutorial
>> I am not still sure about how this section should look like,
>> other than we need one :).
>>
>
> Is this a client API tutorial, an administrator's tutorial, or what? Or do
> we need one of each?
I know I put it down as a section, but I don't know if really need one.
If the client API sections show how to create a connection/session,
send and receive messages, how to configure failover etc.. then I
don't know if we really need a separate examples/tutorials sections.
I believe we can cover enough ground between the getting started and
the Client API's.
But I'd wait till everybody has a chance to chime in.
>> VII. Appendix
>>
>
> OK.
>
> I like this in general.
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Rajith Attapattu <ra...@gmail.com>.
+1 - the sooner we get this off the ground the better.
Next week sounds good to me.
On Wed, Apr 14, 2010 at 1:14 PM, Jonathan Robie
<jo...@redhat.com> wrote:
> On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
>>
>> As I have mentioned in the past, we should just publish what we have right
>> now.
>> If we wait until it's perfect this will never be done.
>> I am not worried about dangling links. We could resolve them in time.
>>
>> What we have now can't be any worse than the current wiki docs.
>> **So please lets publish what we have now.**
>> Once it's more visible more people will participate.
>>
>
> I agree - what we have is no worse than the current Wiki, and getting this
> posted would put pressure on us all to actually use it.
>
> I think a few days would be enough to get rid of a few embarrassing things -
> I can do that next week but not this week, I'm slammed. I suggest the
> following:
>
> 1. Next week, put the svn content up alongside the current Wiki, on the home
> page, with a notice that the Wiki is being phased out as primary
> documentation.
>
> 2. Make all changes to the svn documentation moving forward (it's OK to make
> it to the Wiki too)
>
> 3. Plan to convert completely to the svn documentation in some reasonable
> timeframe (to be defined). Drop the Wiki as soon as we're convinced the svn
> DocBook is good enough to do so.
>
> How does this sound?
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Martin Ritchie <ri...@apache.org>.
On 15 Apr 2010, at 17:24, Robbie Gemmell <ro...@gmail.com>
wrote:
> Anyone modifying the code is responsible for reflecting necessary
> changes into the documentation, there is no single person or group
> of us who are. That said, as I pointed out previously I'm sure
> everyone knows who the usual suspects are when it comes to Java
> broker updates.
>
> We need to draw a line in the sand (or rather, use the one we have
> that was drawn months ago) and get the docbook exporting to the
> website so that there is actually a draw to look at/after it.
>
> Robbie.
>
> On 15 Apr 2010, at 15:20, Jonathan Robie <jo...@redhat.com>
> wrote:
>
>> On 04/15/2010 10:03 AM, Marnie McCormack wrote:
>>> Apologies if I missed anything ....
>>>
>>> I've made a few updates to the wiki over the last few weeks. I'm
>>> assuming
>>> the docbook import will be refreshed before replacing the existing
>>> wiki
>>> content ?
>>>
>>
>> A lot of people have made updates, but updating the docbook source
>> is not an automatic refresh, it's a manual process.
>>
>> I'd like to distribute the work by asking people to reflect updates
>> in the docbook. Also, we do not currently have anyone who is
>> responsible for the Java Broker documentation in the docbook source.
If your looking for a name then i'm happy to ensure the java docs stay
in shape.
Martin
>> Jonathan
>>
>> ---------------------------------------------------------------------
>> Apache Qpid - AMQP Messaging Implementation
>> Project: http://qpid.apache.org
>> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Robbie Gemmell <ro...@gmail.com>.
Anyone modifying the code is responsible for reflecting necessary
changes into the documentation, there is no single person or group of
us who are. That said, as I pointed out previously I'm sure everyone
knows who the usual suspects are when it comes to Java broker updates.
We need to draw a line in the sand (or rather, use the one we have
that was drawn months ago) and get the docbook exporting to the
website so that there is actually a draw to look at/after it.
Robbie.
On 15 Apr 2010, at 15:20, Jonathan Robie <jo...@redhat.com>
wrote:
> On 04/15/2010 10:03 AM, Marnie McCormack wrote:
>> Apologies if I missed anything ....
>>
>> I've made a few updates to the wiki over the last few weeks. I'm
>> assuming
>> the docbook import will be refreshed before replacing the existing
>> wiki
>> content ?
>>
>
> A lot of people have made updates, but updating the docbook source
> is not an automatic refresh, it's a manual process.
>
> I'd like to distribute the work by asking people to reflect updates
> in the docbook. Also, we do not currently have anyone who is
> responsible for the Java Broker documentation in the docbook source.
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 04/15/2010 10:03 AM, Marnie McCormack wrote:
> Apologies if I missed anything ....
>
> I've made a few updates to the wiki over the last few weeks. I'm assuming
> the docbook import will be refreshed before replacing the existing wiki
> content ?
>
A lot of people have made updates, but updating the docbook source is
not an automatic refresh, it's a manual process.
I'd like to distribute the work by asking people to reflect updates in
the docbook. Also, we do not currently have anyone who is responsible
for the Java Broker documentation in the docbook source.
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Marnie McCormack <ma...@googlemail.com>.
Hi,
Apologies if I missed anything ....
I've made a few updates to the wiki over the last few weeks. I'm assuming
the docbook import will be refreshed before replacing the existing wiki
content ?
Marnie
On Thu, Apr 15, 2010 at 2:34 PM, Jonathan Robie
<jo...@redhat.com>wrote:
> On 04/15/2010 09:16 AM, Alan Conway wrote:
>
>> On 04/14/2010 01:14 PM, Jonathan Robie wrote:
>>
>>> On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
>>>
>>>> As I have mentioned in the past, we should just publish what we have
>>>> right now.
>>>> If we wait until it's perfect this will never be done.
>>>> I am not worried about dangling links. We could resolve them in time.
>>>>
>>>> What we have now can't be any worse than the current wiki docs.
>>>> **So please lets publish what we have now.**
>>>> Once it's more visible more people will participate.
>>>>
>>>
>>> I agree - what we have is no worse than the current Wiki, and getting
>>> this posted would put pressure on us all to actually use it.
>>>
>>> I think a few days would be enough to get rid of a few embarrassing
>>> things - I can do that next week but not this week, I'm slammed. I
>>> suggest the following:
>>>
>>> 1. Next week, put the svn content up alongside the current Wiki, on the
>>> home page, with a notice that the Wiki is being phased out as primary
>>> documentation.
>>>
>>> 2. Make all changes to the svn documentation moving forward (it's OK to
>>> make it to the Wiki too)
>>>
>>> 3. Plan to convert completely to the svn documentation in some
>>> reasonable timeframe (to be defined). Drop the Wiki as soon as we're
>>> convinced the svn DocBook is good enough to do so.
>>>
>>> How does this sound?
>>>
>>>
>> Sounds good to me, but I just want to clarify: We're not talking about
>> replacing the entire wiki with docbook, only the documentation pages. The
>> project related stuff (getting started, where to download etc.) stays on the
>> wiki. Right?
>>
>
> Current system:
>
> * Everything is a Wiki
>
> Proposed system:
>
> * Rajith's static HTML pages for initial landing page, project info
> * DocBook in svn for documentation
> * Wiki plays a much less prominent role
>
> I think the goal is to put project-related stuff on static HTML pages -
> things like "Getting Started" and "Where to Download", as well as guidance
> for new contributers, etc. would live there.
>
>
> I suggest we be aggressive about getting docbook on line and deleting the
>> redundant wiki content as soon as we can. If the docbook needs polish,
>> better to do that after we've switched than to prolong the confusing
>> docbook/wiki redundancy.
>>
>
> OK. Makes sense. We'll put this up next week, alongside the Wiki, and start
> deleting redundant Wiki content.
>
> Jonathan
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 04/15/2010 09:16 AM, Alan Conway wrote:
> On 04/14/2010 01:14 PM, Jonathan Robie wrote:
>> On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
>>> As I have mentioned in the past, we should just publish what we have
>>> right now.
>>> If we wait until it's perfect this will never be done.
>>> I am not worried about dangling links. We could resolve them in time.
>>>
>>> What we have now can't be any worse than the current wiki docs.
>>> **So please lets publish what we have now.**
>>> Once it's more visible more people will participate.
>>
>> I agree - what we have is no worse than the current Wiki, and getting
>> this posted would put pressure on us all to actually use it.
>>
>> I think a few days would be enough to get rid of a few embarrassing
>> things - I can do that next week but not this week, I'm slammed. I
>> suggest the following:
>>
>> 1. Next week, put the svn content up alongside the current Wiki, on the
>> home page, with a notice that the Wiki is being phased out as primary
>> documentation.
>>
>> 2. Make all changes to the svn documentation moving forward (it's OK to
>> make it to the Wiki too)
>>
>> 3. Plan to convert completely to the svn documentation in some
>> reasonable timeframe (to be defined). Drop the Wiki as soon as we're
>> convinced the svn DocBook is good enough to do so.
>>
>> How does this sound?
>>
>
> Sounds good to me, but I just want to clarify: We're not talking about
> replacing the entire wiki with docbook, only the documentation pages.
> The project related stuff (getting started, where to download etc.)
> stays on the wiki. Right?
Current system:
* Everything is a Wiki
Proposed system:
* Rajith's static HTML pages for initial landing page, project info
* DocBook in svn for documentation
* Wiki plays a much less prominent role
I think the goal is to put project-related stuff on static HTML pages -
things like "Getting Started" and "Where to Download", as well as
guidance for new contributers, etc. would live there.
> I suggest we be aggressive about getting docbook on line and deleting
> the redundant wiki content as soon as we can. If the docbook needs
> polish, better to do that after we've switched than to prolong the
> confusing docbook/wiki redundancy.
OK. Makes sense. We'll put this up next week, alongside the Wiki, and
start deleting redundant Wiki content.
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Alan Conway <ac...@redhat.com>.
On 04/14/2010 01:14 PM, Jonathan Robie wrote:
> On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
>> As I have mentioned in the past, we should just publish what we have
>> right now.
>> If we wait until it's perfect this will never be done.
>> I am not worried about dangling links. We could resolve them in time.
>>
>> What we have now can't be any worse than the current wiki docs.
>> **So please lets publish what we have now.**
>> Once it's more visible more people will participate.
>
> I agree - what we have is no worse than the current Wiki, and getting
> this posted would put pressure on us all to actually use it.
>
> I think a few days would be enough to get rid of a few embarrassing
> things - I can do that next week but not this week, I'm slammed. I
> suggest the following:
>
> 1. Next week, put the svn content up alongside the current Wiki, on the
> home page, with a notice that the Wiki is being phased out as primary
> documentation.
>
> 2. Make all changes to the svn documentation moving forward (it's OK to
> make it to the Wiki too)
>
> 3. Plan to convert completely to the svn documentation in some
> reasonable timeframe (to be defined). Drop the Wiki as soon as we're
> convinced the svn DocBook is good enough to do so.
>
> How does this sound?
>
Sounds good to me, but I just want to clarify: We're not talking about replacing
the entire wiki with docbook, only the documentation pages. The project related
stuff (getting started, where to download etc.) stays on the wiki. Right?
I suggest we be aggressive about getting docbook on line and deleting the
redundant wiki content as soon as we can. If the docbook needs polish, better to
do that after we've switched than to prolong the confusing docbook/wiki redundancy.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 04/14/2010 10:24 AM, Rajith Attapattu wrote:
> As I have mentioned in the past, we should just publish what we have right now.
> If we wait until it's perfect this will never be done.
> I am not worried about dangling links. We could resolve them in time.
>
> What we have now can't be any worse than the current wiki docs.
> **So please lets publish what we have now.**
> Once it's more visible more people will participate.
>
I agree - what we have is no worse than the current Wiki, and getting
this posted would put pressure on us all to actually use it.
I think a few days would be enough to get rid of a few embarrassing
things - I can do that next week but not this week, I'm slammed. I
suggest the following:
1. Next week, put the svn content up alongside the current Wiki, on the
home page, with a notice that the Wiki is being phased out as primary
documentation.
2. Make all changes to the svn documentation moving forward (it's OK to
make it to the Wiki too)
3. Plan to convert completely to the svn documentation in some
reasonable timeframe (to be defined). Drop the Wiki as soon as we're
convinced the svn DocBook is good enough to do so.
How does this sound?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Martin Ritchie <ri...@apache.org>.
On 14 April 2010 15:24, Rajith Attapattu <ra...@gmail.com> wrote:
> As I have mentioned in the past, we should just publish what we have right now.
> If we wait until it's perfect this will never be done.
> I am not worried about dangling links. We could resolve them in time.
>
> What we have now can't be any worse than the current wiki docs.
> **So please lets publish what we have now.**
> Once it's more visible more people will participate.
+1, let's get an the export of docbook from svn to web automated.
Can some one with a more permissive firewall sort this out?
> Regards,
>
> Rajith
> On Wed, Apr 14, 2010 at 9:31 AM, Jonathan Robie
> <jo...@redhat.com> wrote:
>> On 04/14/2010 07:11 AM, Martin Ritchie wrote:
>>>
>>> On 16 March 2010 23:19, Rajith Attapattu<ra...@gmail.com> wrote:
>>>
>>>>
>>>> On Tue, Mar 16, 2010 at 6:12 PM, Robbie Gemmell
>>>> <ro...@gmail.com> wrote:
>>>>
>>>>>
>>>>> There were suggestions some months ago around having the website become
>>>>> a
>>>>> combination of static main pages and generated user doc pages/pdf coming
>>>>> from the DocBook source, with the wiki hanging off to the side for
>>>>> development work. Is that still the end game?
>>>>>
>>>>
>>>> Yes it is. After the prototype I did last time, a lot of folks said
>>>> they would like "blue" instead of "brown" :)
>>>> I will try to do it this weekend and post another prototype. Hopefully
>>>> people will like it !
>>>>
>>>
>>> I think we are in danger of losing some work here. If we don't make
>>> the change soon then we will have docs in svn that users can't easily
>>> access and docs on the wiki that potentially will get lost when the
>>> migration occurs.
>>>
>>> It would be great if we could have a time line for replacing the wiki
>>> page with an exported docbook site.
>>>
>>
>> I agree.
>>
>> Perhaps we need to organize a team of editors to work on this? I volunteer
>> to be one of them. Perhaps we should figure out who is on the team and
>> create our plan and our schedule together.
>>
>> A straight export didn't work for a variety of reasons, what we have checked
>> in is a straight export followed by manual tweaking to impose structure, get
>> rid of references to things that are completely out of date, etc. There are
>> some problems with dangling links and such, and a lot more problems because
>> the original Wiki pages were not written to be part of one document, reflect
>> various versions of things, etc. It was a significant amount of work.
I don't think we need a team of editors, all developers are
responsible for the documentation.
I think one of the mistakes we are making is the thinking that it
should be one document. It should be one web site of documentation. I
don't believe it should read as a user manual.
The first task should be just to get the content on line.
If we have plans to provide a series of documents focused to a
particular audience we can address that once things have settled.
I'm very appreciative of all the work Jonathan and others have done in
the initial export and organisation but getting it up on the web will
help everyone really see what has been done.
>> As you say, work is currently being lost. I'm not reflecting new changes to
>> the Wiki into these docs, someone will have to do this. Particularly for the
>> Java broker. So far, I don't know who is responsible for the Java broker
>> docs.
Lets just get the docbook up in a parallel mode to the wiki so we can
verify that things are not lost, from either side.
The longer we don't have docbook on the web the more pressure there
will be to do a re-export as there will be more changes on the wiki.
>> On the C++ broker side, we have lots of documents we want to contribute
>> upstream, and I think they are generally in better shape than the existing
>> Wiki information. And we're doing the new API docs upstream to start with.
>>
>>> We can work on tweeking the colours once it is live.
>>>
>>> Are we in a place where we can just export and see what it is like?
>>>
>>
>> I think what is in svn now tells you what it is like. There's a build system
>> there, so you can see what it's like. It's pretty rough, it needs editing.
>>
>> I am doing tutorial for the new API, and doing that upstream. I will also
>> contribute a lot of Red Hat docs for the C++ broker after stripping Red
>> Hat-specific stuff. Someone else needs to do the heavy lifting for the Java
>> broker and WCF docs. I hope we'll all be making changes to the docs as we
>> change the code.
>>
>> Can I sign you up as one of the editors?
Like it or not all the committers are editors. If we get the docbook
on the web then I will work to move any new content from wiki to
docbook.
>> Jonathan
>>
>> ---------------------------------------------------------------------
>> Apache Qpid - AMQP Messaging Implementation
>> Project: http://qpid.apache.org
>> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
>
>
--
Martin Ritchie
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Rajith Attapattu <ra...@gmail.com>.
As I have mentioned in the past, we should just publish what we have right now.
If we wait until it's perfect this will never be done.
I am not worried about dangling links. We could resolve them in time.
What we have now can't be any worse than the current wiki docs.
**So please lets publish what we have now.**
Once it's more visible more people will participate.
Regards,
Rajith
On Wed, Apr 14, 2010 at 9:31 AM, Jonathan Robie
<jo...@redhat.com> wrote:
> On 04/14/2010 07:11 AM, Martin Ritchie wrote:
>>
>> On 16 March 2010 23:19, Rajith Attapattu<ra...@gmail.com> wrote:
>>
>>>
>>> On Tue, Mar 16, 2010 at 6:12 PM, Robbie Gemmell
>>> <ro...@gmail.com> wrote:
>>>
>>>>
>>>> There were suggestions some months ago around having the website become
>>>> a
>>>> combination of static main pages and generated user doc pages/pdf coming
>>>> from the DocBook source, with the wiki hanging off to the side for
>>>> development work. Is that still the end game?
>>>>
>>>
>>> Yes it is. After the prototype I did last time, a lot of folks said
>>> they would like "blue" instead of "brown" :)
>>> I will try to do it this weekend and post another prototype. Hopefully
>>> people will like it !
>>>
>>
>> I think we are in danger of losing some work here. If we don't make
>> the change soon then we will have docs in svn that users can't easily
>> access and docs on the wiki that potentially will get lost when the
>> migration occurs.
>>
>> It would be great if we could have a time line for replacing the wiki
>> page with an exported docbook site.
>>
>
> I agree.
>
> Perhaps we need to organize a team of editors to work on this? I volunteer
> to be one of them. Perhaps we should figure out who is on the team and
> create our plan and our schedule together.
>
> A straight export didn't work for a variety of reasons, what we have checked
> in is a straight export followed by manual tweaking to impose structure, get
> rid of references to things that are completely out of date, etc. There are
> some problems with dangling links and such, and a lot more problems because
> the original Wiki pages were not written to be part of one document, reflect
> various versions of things, etc. It was a significant amount of work.
>
> As you say, work is currently being lost. I'm not reflecting new changes to
> the Wiki into these docs, someone will have to do this. Particularly for the
> Java broker. So far, I don't know who is responsible for the Java broker
> docs.
>
> On the C++ broker side, we have lots of documents we want to contribute
> upstream, and I think they are generally in better shape than the existing
> Wiki information. And we're doing the new API docs upstream to start with.
>
>> We can work on tweeking the colours once it is live.
>>
>> Are we in a place where we can just export and see what it is like?
>>
>
> I think what is in svn now tells you what it is like. There's a build system
> there, so you can see what it's like. It's pretty rough, it needs editing.
>
> I am doing tutorial for the new API, and doing that upstream. I will also
> contribute a lot of Red Hat docs for the C++ broker after stripping Red
> Hat-specific stuff. Someone else needs to do the heavy lifting for the Java
> broker and WCF docs. I hope we'll all be making changes to the docs as we
> change the code.
>
> Can I sign you up as one of the editors?
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 04/14/2010 07:11 AM, Martin Ritchie wrote:
> On 16 March 2010 23:19, Rajith Attapattu<ra...@gmail.com> wrote:
>
>> On Tue, Mar 16, 2010 at 6:12 PM, Robbie Gemmell
>> <ro...@gmail.com> wrote:
>>
>>> There were suggestions some months ago around having the website become a
>>> combination of static main pages and generated user doc pages/pdf coming
>>> from the DocBook source, with the wiki hanging off to the side for
>>> development work. Is that still the end game?
>>>
>> Yes it is. After the prototype I did last time, a lot of folks said
>> they would like "blue" instead of "brown" :)
>> I will try to do it this weekend and post another prototype. Hopefully
>> people will like it !
>>
> I think we are in danger of losing some work here. If we don't make
> the change soon then we will have docs in svn that users can't easily
> access and docs on the wiki that potentially will get lost when the
> migration occurs.
>
> It would be great if we could have a time line for replacing the wiki
> page with an exported docbook site.
>
I agree.
Perhaps we need to organize a team of editors to work on this? I
volunteer to be one of them. Perhaps we should figure out who is on the
team and create our plan and our schedule together.
A straight export didn't work for a variety of reasons, what we have
checked in is a straight export followed by manual tweaking to impose
structure, get rid of references to things that are completely out of
date, etc. There are some problems with dangling links and such, and a
lot more problems because the original Wiki pages were not written to be
part of one document, reflect various versions of things, etc. It was a
significant amount of work.
As you say, work is currently being lost. I'm not reflecting new changes
to the Wiki into these docs, someone will have to do this. Particularly
for the Java broker. So far, I don't know who is responsible for the
Java broker docs.
On the C++ broker side, we have lots of documents we want to contribute
upstream, and I think they are generally in better shape than the
existing Wiki information. And we're doing the new API docs upstream to
start with.
> We can work on tweeking the colours once it is live.
>
> Are we in a place where we can just export and see what it is like?
>
I think what is in svn now tells you what it is like. There's a build
system there, so you can see what it's like. It's pretty rough, it needs
editing.
I am doing tutorial for the new API, and doing that upstream. I will
also contribute a lot of Red Hat docs for the C++ broker after stripping
Red Hat-specific stuff. Someone else needs to do the heavy lifting for
the Java broker and WCF docs. I hope we'll all be making changes to the
docs as we change the code.
Can I sign you up as one of the editors?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Martin Ritchie <ri...@apache.org>.
On 16 March 2010 23:19, Rajith Attapattu <ra...@gmail.com> wrote:
> On Tue, Mar 16, 2010 at 6:12 PM, Robbie Gemmell
> <ro...@gmail.com> wrote:
>> There were suggestions some months ago around having the website become a
>> combination of static main pages and generated user doc pages/pdf coming
>> from the DocBook source, with the wiki hanging off to the side for
>> development work. Is that still the end game?
>
> Yes it is. After the prototype I did last time, a lot of folks said
> they would like "blue" instead of "brown" :)
> I will try to do it this weekend and post another prototype. Hopefully
> people will like it !
I think we are in danger of losing some work here. If we don't make
the change soon then we will have docs in svn that users can't easily
access and docs on the wiki that potentially will get lost when the
migration occurs.
It would be great if we could have a time line for replacing the wiki
page with an exported docbook site.
We can work on tweeking the colours once it is live.
Are we in a place where we can just export and see what it is like?
Cheers
Martin
>> I'd like to see us pick something (Rajith's suggestions seem like a decent
>> starting point) and make the switch quickly to stop the process dragging on.
>> If all design + development related docs stay based on the wiki then the
>> remainder seems like it has been fairly stagnant, so we should just decide
>> to draw a line at some and make the DocBook switch, once we can integrate it
>> into the site that is.
>>
>> Robbie
>>
>>> -----Original Message-----
>>> From: Jonathan Robie [mailto:jonathan.robie@redhat.com]
>>> Sent: 16 March 2010 15:37
>>> To: dev@qpid.apache.org
>>> Subject: Re: Qpid docs - file structure and organization
>>>
>>> On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
>>> > Here are some general comments.
>>> > Frankly I am not too happy with the current format.
>>> >
>>>
>>> That's fine - the current format was created in order to use existing
>>> Wiki pages with as little modification as possible, with enough
>>> organization for the sake of sanity.
>>>
>>> I want to know where we are heading, and move in that direction, rather
>>> than polish what we have before setting goals. The most important thing
>>> right now is to establish a common direction.
>>>
>>> > I'd like to see the following in the docs.
>>> >
>>> > 1. The user guide should be tied to a particular version, as we are
>>> > shipping them for each release.
>>> >
>>>
>>> Absolutely. And I think we need to start by setting a goal here. I
>>> propopose that we aim to have up-to-date docs for release 7 - I can put
>>> the release number on the front page.
>>>
>>> Currently, we have a hodge-podge of docs corresponding to different
>>> versions, and for some of this material I simply don't know what
>>> versions it corresponds to.
>>>
>>> > 2. The guide should focus on end users, not developers. So we should
>>> > get rid of all design docs.
>>> >
>>>
>>>
>>> Agreed.
>>>
>>>
>>> > 3. Our documentation should reflect the goals, vision and direction
>>> of
>>> > the project.
>>> >
>>> > a) Brokers with a common set of features
>>> > b) Management tools that work with both brokers
>>> > c) Common Client API's
>>> > d) Interoperability via examples
>>> >
>>>
>>>
>>> OK.
>>>
>>>
>>> > 4. I would like to see the TOC as follows.
>>> >
>>> > I. Introduction
>>> > What you have here is fine, but I am not sure about the getting
>>> > started and download stuff. I need to think about it a bit more.
>>> >
>>>
>>> OK.
>>>
>>> I think the goal of the introduction should be:
>>>
>>> 1. To introduce the most important concepts briefly
>>> 2. To show the user how to get up and running, to the point of being
>>> able to run an example.
>>>
>>> > II. AMQP Messaging Brokers
>>> > I think rather than having separate sections for each broker,
>>> it's
>>> > best to describe common functionality first then we can have separate
>>> > chapters for each broker.
>>> > Recently Rob Godfrey has done a tremendous amount of work to
>>> bring
>>> > the Java broker inline with the c++ broker in terms of features.
>>> > Ex. Federation, QMF support, LVQ etc... (in addition common
>>> > features include ACL, Authentication, SSL ..etc)
>>> >
>>> > So perhaps the section can be organized as,
>>> > Chapter 1. Broker concepts (Federation, Security {ACL,
>>> > Authentication, SSL}, QMF, LVQ ..etc)
>>> > Chapter 2. Java Broker
>>> > Chapter 3. C++ Broker
>>> > (Chapters 2&3 describes the specifics like how to install, run,
>>> and
>>> > configure)
>>> >
>>>
>>>
>>> This makes sense - I have not been following the Java Broker, I didn't
>>> know how much progress had been made. Cool!
>>>
>>>
>>> > II. AMQP Messaging Clients
>>> > We should again explain the common concepts and vision behind the
>>> > client API's while stating that JMS and WCF are following
>>> idioms/API's
>>> > that are already defined for those domains.
>>> > The specific chapters on each client will focus on the languages
>>> > specific items like (how to open a connection, receive a message,
>>> send
>>> > a message ..etc) and the relevant configuration options.
>>> >
>>> > Chapter 1. API and addressing syntax.
>>> > Chapter 2. Python Client
>>> > Chapter 3. C++ Client
>>> > Chapter 4. JMS Client
>>> > Chapter 5. WCF Client
>>> > Chapter 6. Ruby Client
>>> >
>>>
>>>
>>> Good. I assume that we will use the high level APIs in all this.
>>>
>>>
>>> > III. AMQP Messaging Broker Management.
>>> > This should be a top level section on it's own rather than
>>> > anything that C++/Java broker specific. A majority of these tools can
>>> > be used against both.
>>> > We should state that our brokers can be managed using QMF (and
>>> JMX
>>> > - the Java broker directly and the C++ broker via QMan).
>>> >
>>> > Chapter 1. Python management tools - (qpid-config,......)
>>> > Chapter 2. QMan.
>>> > QMF-to-JMX bridge
>>> > QMF-to-WSDM bridge
>>> > Chapter 3. Eclipse pluggins
>>> >
>>>
>>>
>>> OK. Any volunteers for the Qman and Eclipse sections?
>>>
>>>
>>> > IV. QMF
>>> > This is actually a sub project of Qpid that can be used to
>>> manage
>>> > anything. So IMO it deserves it's own section.
>>> >
>>> > Chapter 1. QMF Concepts
>>> > Chapter 2. QMF C++ API
>>> > Chapter 2. QMF Python API
>>> > Chapter 4. QMF Java API
>>> >
>>>
>>> OK
>>>
>>> > V. Testing Frameworks and Tools
>>> > Here we can talk about our testing frameworks and perf tools
>>> >
>>>
>>> Makes sense.
>>>
>>> > VI. Examples/Tutorial
>>> > I am not still sure about how this section should look like,
>>> > other than we need one :).
>>> >
>>>
>>> Is this a client API tutorial, an administrator's tutorial, or what? Or
>>> do we need one of each?
>>>
>>> > VII. Appendix
>>> >
>>>
>>> OK.
>>>
>>> I like this in general.
>>>
>>> Jonathan
>>>
>>> ---------------------------------------------------------------------
>>> Apache Qpid - AMQP Messaging Implementation
>>> Project: http://qpid.apache.org
>>> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>>
>>
>>
>> ---------------------------------------------------------------------
>> Apache Qpid - AMQP Messaging Implementation
>> Project: http://qpid.apache.org
>> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
>
>
--
Martin Ritchie
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Rajith Attapattu <ra...@gmail.com>.
On Tue, Mar 16, 2010 at 6:12 PM, Robbie Gemmell
<ro...@gmail.com> wrote:
> There were suggestions some months ago around having the website become a
> combination of static main pages and generated user doc pages/pdf coming
> from the DocBook source, with the wiki hanging off to the side for
> development work. Is that still the end game?
Yes it is. After the prototype I did last time, a lot of folks said
they would like "blue" instead of "brown" :)
I will try to do it this weekend and post another prototype. Hopefully
people will like it !
> I'd like to see us pick something (Rajith's suggestions seem like a decent
> starting point) and make the switch quickly to stop the process dragging on.
> If all design + development related docs stay based on the wiki then the
> remainder seems like it has been fairly stagnant, so we should just decide
> to draw a line at some and make the DocBook switch, once we can integrate it
> into the site that is.
>
> Robbie
>
>> -----Original Message-----
>> From: Jonathan Robie [mailto:jonathan.robie@redhat.com]
>> Sent: 16 March 2010 15:37
>> To: dev@qpid.apache.org
>> Subject: Re: Qpid docs - file structure and organization
>>
>> On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
>> > Here are some general comments.
>> > Frankly I am not too happy with the current format.
>> >
>>
>> That's fine - the current format was created in order to use existing
>> Wiki pages with as little modification as possible, with enough
>> organization for the sake of sanity.
>>
>> I want to know where we are heading, and move in that direction, rather
>> than polish what we have before setting goals. The most important thing
>> right now is to establish a common direction.
>>
>> > I'd like to see the following in the docs.
>> >
>> > 1. The user guide should be tied to a particular version, as we are
>> > shipping them for each release.
>> >
>>
>> Absolutely. And I think we need to start by setting a goal here. I
>> propopose that we aim to have up-to-date docs for release 7 - I can put
>> the release number on the front page.
>>
>> Currently, we have a hodge-podge of docs corresponding to different
>> versions, and for some of this material I simply don't know what
>> versions it corresponds to.
>>
>> > 2. The guide should focus on end users, not developers. So we should
>> > get rid of all design docs.
>> >
>>
>>
>> Agreed.
>>
>>
>> > 3. Our documentation should reflect the goals, vision and direction
>> of
>> > the project.
>> >
>> > a) Brokers with a common set of features
>> > b) Management tools that work with both brokers
>> > c) Common Client API's
>> > d) Interoperability via examples
>> >
>>
>>
>> OK.
>>
>>
>> > 4. I would like to see the TOC as follows.
>> >
>> > I. Introduction
>> > What you have here is fine, but I am not sure about the getting
>> > started and download stuff. I need to think about it a bit more.
>> >
>>
>> OK.
>>
>> I think the goal of the introduction should be:
>>
>> 1. To introduce the most important concepts briefly
>> 2. To show the user how to get up and running, to the point of being
>> able to run an example.
>>
>> > II. AMQP Messaging Brokers
>> > I think rather than having separate sections for each broker,
>> it's
>> > best to describe common functionality first then we can have separate
>> > chapters for each broker.
>> > Recently Rob Godfrey has done a tremendous amount of work to
>> bring
>> > the Java broker inline with the c++ broker in terms of features.
>> > Ex. Federation, QMF support, LVQ etc... (in addition common
>> > features include ACL, Authentication, SSL ..etc)
>> >
>> > So perhaps the section can be organized as,
>> > Chapter 1. Broker concepts (Federation, Security {ACL,
>> > Authentication, SSL}, QMF, LVQ ..etc)
>> > Chapter 2. Java Broker
>> > Chapter 3. C++ Broker
>> > (Chapters 2&3 describes the specifics like how to install, run,
>> and
>> > configure)
>> >
>>
>>
>> This makes sense - I have not been following the Java Broker, I didn't
>> know how much progress had been made. Cool!
>>
>>
>> > II. AMQP Messaging Clients
>> > We should again explain the common concepts and vision behind the
>> > client API's while stating that JMS and WCF are following
>> idioms/API's
>> > that are already defined for those domains.
>> > The specific chapters on each client will focus on the languages
>> > specific items like (how to open a connection, receive a message,
>> send
>> > a message ..etc) and the relevant configuration options.
>> >
>> > Chapter 1. API and addressing syntax.
>> > Chapter 2. Python Client
>> > Chapter 3. C++ Client
>> > Chapter 4. JMS Client
>> > Chapter 5. WCF Client
>> > Chapter 6. Ruby Client
>> >
>>
>>
>> Good. I assume that we will use the high level APIs in all this.
>>
>>
>> > III. AMQP Messaging Broker Management.
>> > This should be a top level section on it's own rather than
>> > anything that C++/Java broker specific. A majority of these tools can
>> > be used against both.
>> > We should state that our brokers can be managed using QMF (and
>> JMX
>> > - the Java broker directly and the C++ broker via QMan).
>> >
>> > Chapter 1. Python management tools - (qpid-config,......)
>> > Chapter 2. QMan.
>> > QMF-to-JMX bridge
>> > QMF-to-WSDM bridge
>> > Chapter 3. Eclipse pluggins
>> >
>>
>>
>> OK. Any volunteers for the Qman and Eclipse sections?
>>
>>
>> > IV. QMF
>> > This is actually a sub project of Qpid that can be used to
>> manage
>> > anything. So IMO it deserves it's own section.
>> >
>> > Chapter 1. QMF Concepts
>> > Chapter 2. QMF C++ API
>> > Chapter 2. QMF Python API
>> > Chapter 4. QMF Java API
>> >
>>
>> OK
>>
>> > V. Testing Frameworks and Tools
>> > Here we can talk about our testing frameworks and perf tools
>> >
>>
>> Makes sense.
>>
>> > VI. Examples/Tutorial
>> > I am not still sure about how this section should look like,
>> > other than we need one :).
>> >
>>
>> Is this a client API tutorial, an administrator's tutorial, or what? Or
>> do we need one of each?
>>
>> > VII. Appendix
>> >
>>
>> OK.
>>
>> I like this in general.
>>
>> Jonathan
>>
>> ---------------------------------------------------------------------
>> Apache Qpid - AMQP Messaging Implementation
>> Project: http://qpid.apache.org
>> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
RE: Qpid docs - file structure and organization
Posted by Robbie Gemmell <ro...@gmail.com>.
There were suggestions some months ago around having the website become a
combination of static main pages and generated user doc pages/pdf coming
from the DocBook source, with the wiki hanging off to the side for
development work. Is that still the end game?
I'd like to see us pick something (Rajith's suggestions seem like a decent
starting point) and make the switch quickly to stop the process dragging on.
If all design + development related docs stay based on the wiki then the
remainder seems like it has been fairly stagnant, so we should just decide
to draw a line at some and make the DocBook switch, once we can integrate it
into the site that is.
Robbie
> -----Original Message-----
> From: Jonathan Robie [mailto:jonathan.robie@redhat.com]
> Sent: 16 March 2010 15:37
> To: dev@qpid.apache.org
> Subject: Re: Qpid docs - file structure and organization
>
> On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
> > Here are some general comments.
> > Frankly I am not too happy with the current format.
> >
>
> That's fine - the current format was created in order to use existing
> Wiki pages with as little modification as possible, with enough
> organization for the sake of sanity.
>
> I want to know where we are heading, and move in that direction, rather
> than polish what we have before setting goals. The most important thing
> right now is to establish a common direction.
>
> > I'd like to see the following in the docs.
> >
> > 1. The user guide should be tied to a particular version, as we are
> > shipping them for each release.
> >
>
> Absolutely. And I think we need to start by setting a goal here. I
> propopose that we aim to have up-to-date docs for release 7 - I can put
> the release number on the front page.
>
> Currently, we have a hodge-podge of docs corresponding to different
> versions, and for some of this material I simply don't know what
> versions it corresponds to.
>
> > 2. The guide should focus on end users, not developers. So we should
> > get rid of all design docs.
> >
>
>
> Agreed.
>
>
> > 3. Our documentation should reflect the goals, vision and direction
> of
> > the project.
> >
> > a) Brokers with a common set of features
> > b) Management tools that work with both brokers
> > c) Common Client API's
> > d) Interoperability via examples
> >
>
>
> OK.
>
>
> > 4. I would like to see the TOC as follows.
> >
> > I. Introduction
> > What you have here is fine, but I am not sure about the getting
> > started and download stuff. I need to think about it a bit more.
> >
>
> OK.
>
> I think the goal of the introduction should be:
>
> 1. To introduce the most important concepts briefly
> 2. To show the user how to get up and running, to the point of being
> able to run an example.
>
> > II. AMQP Messaging Brokers
> > I think rather than having separate sections for each broker,
> it's
> > best to describe common functionality first then we can have separate
> > chapters for each broker.
> > Recently Rob Godfrey has done a tremendous amount of work to
> bring
> > the Java broker inline with the c++ broker in terms of features.
> > Ex. Federation, QMF support, LVQ etc... (in addition common
> > features include ACL, Authentication, SSL ..etc)
> >
> > So perhaps the section can be organized as,
> > Chapter 1. Broker concepts (Federation, Security {ACL,
> > Authentication, SSL}, QMF, LVQ ..etc)
> > Chapter 2. Java Broker
> > Chapter 3. C++ Broker
> > (Chapters 2&3 describes the specifics like how to install, run,
> and
> > configure)
> >
>
>
> This makes sense - I have not been following the Java Broker, I didn't
> know how much progress had been made. Cool!
>
>
> > II. AMQP Messaging Clients
> > We should again explain the common concepts and vision behind the
> > client API's while stating that JMS and WCF are following
> idioms/API's
> > that are already defined for those domains.
> > The specific chapters on each client will focus on the languages
> > specific items like (how to open a connection, receive a message,
> send
> > a message ..etc) and the relevant configuration options.
> >
> > Chapter 1. API and addressing syntax.
> > Chapter 2. Python Client
> > Chapter 3. C++ Client
> > Chapter 4. JMS Client
> > Chapter 5. WCF Client
> > Chapter 6. Ruby Client
> >
>
>
> Good. I assume that we will use the high level APIs in all this.
>
>
> > III. AMQP Messaging Broker Management.
> > This should be a top level section on it's own rather than
> > anything that C++/Java broker specific. A majority of these tools can
> > be used against both.
> > We should state that our brokers can be managed using QMF (and
> JMX
> > - the Java broker directly and the C++ broker via QMan).
> >
> > Chapter 1. Python management tools - (qpid-config,......)
> > Chapter 2. QMan.
> > QMF-to-JMX bridge
> > QMF-to-WSDM bridge
> > Chapter 3. Eclipse pluggins
> >
>
>
> OK. Any volunteers for the Qman and Eclipse sections?
>
>
> > IV. QMF
> > This is actually a sub project of Qpid that can be used to
> manage
> > anything. So IMO it deserves it's own section.
> >
> > Chapter 1. QMF Concepts
> > Chapter 2. QMF C++ API
> > Chapter 2. QMF Python API
> > Chapter 4. QMF Java API
> >
>
> OK
>
> > V. Testing Frameworks and Tools
> > Here we can talk about our testing frameworks and perf tools
> >
>
> Makes sense.
>
> > VI. Examples/Tutorial
> > I am not still sure about how this section should look like,
> > other than we need one :).
> >
>
> Is this a client API tutorial, an administrator's tutorial, or what? Or
> do we need one of each?
>
> > VII. Appendix
> >
>
> OK.
>
> I like this in general.
>
> Jonathan
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 03/16/2010 11:13 AM, Rajith Attapattu wrote:
> Here are some general comments.
> Frankly I am not too happy with the current format.
>
That's fine - the current format was created in order to use existing
Wiki pages with as little modification as possible, with enough
organization for the sake of sanity.
I want to know where we are heading, and move in that direction, rather
than polish what we have before setting goals. The most important thing
right now is to establish a common direction.
> I'd like to see the following in the docs.
>
> 1. The user guide should be tied to a particular version, as we are
> shipping them for each release.
>
Absolutely. And I think we need to start by setting a goal here. I
propopose that we aim to have up-to-date docs for release 7 - I can put
the release number on the front page.
Currently, we have a hodge-podge of docs corresponding to different
versions, and for some of this material I simply don't know what
versions it corresponds to.
> 2. The guide should focus on end users, not developers. So we should
> get rid of all design docs.
>
Agreed.
> 3. Our documentation should reflect the goals, vision and direction of
> the project.
>
> a) Brokers with a common set of features
> b) Management tools that work with both brokers
> c) Common Client API's
> d) Interoperability via examples
>
OK.
> 4. I would like to see the TOC as follows.
>
> I. Introduction
> What you have here is fine, but I am not sure about the getting
> started and download stuff. I need to think about it a bit more.
>
OK.
I think the goal of the introduction should be:
1. To introduce the most important concepts briefly
2. To show the user how to get up and running, to the point of being
able to run an example.
> II. AMQP Messaging Brokers
> I think rather than having separate sections for each broker, it's
> best to describe common functionality first then we can have separate
> chapters for each broker.
> Recently Rob Godfrey has done a tremendous amount of work to bring
> the Java broker inline with the c++ broker in terms of features.
> Ex. Federation, QMF support, LVQ etc... (in addition common
> features include ACL, Authentication, SSL ..etc)
>
> So perhaps the section can be organized as,
> Chapter 1. Broker concepts (Federation, Security {ACL,
> Authentication, SSL}, QMF, LVQ ..etc)
> Chapter 2. Java Broker
> Chapter 3. C++ Broker
> (Chapters 2&3 describes the specifics like how to install, run, and
> configure)
>
This makes sense - I have not been following the Java Broker, I didn't
know how much progress had been made. Cool!
> II. AMQP Messaging Clients
> We should again explain the common concepts and vision behind the
> client API's while stating that JMS and WCF are following idioms/API's
> that are already defined for those domains.
> The specific chapters on each client will focus on the languages
> specific items like (how to open a connection, receive a message, send
> a message ..etc) and the relevant configuration options.
>
> Chapter 1. API and addressing syntax.
> Chapter 2. Python Client
> Chapter 3. C++ Client
> Chapter 4. JMS Client
> Chapter 5. WCF Client
> Chapter 6. Ruby Client
>
Good. I assume that we will use the high level APIs in all this.
> III. AMQP Messaging Broker Management.
> This should be a top level section on it's own rather than
> anything that C++/Java broker specific. A majority of these tools can
> be used against both.
> We should state that our brokers can be managed using QMF (and JMX
> - the Java broker directly and the C++ broker via QMan).
>
> Chapter 1. Python management tools - (qpid-config,......)
> Chapter 2. QMan.
> QMF-to-JMX bridge
> QMF-to-WSDM bridge
> Chapter 3. Eclipse pluggins
>
OK. Any volunteers for the Qman and Eclipse sections?
> IV. QMF
> This is actually a sub project of Qpid that can be used to manage
> anything. So IMO it deserves it's own section.
>
> Chapter 1. QMF Concepts
> Chapter 2. QMF C++ API
> Chapter 2. QMF Python API
> Chapter 4. QMF Java API
>
OK
> V. Testing Frameworks and Tools
> Here we can talk about our testing frameworks and perf tools
>
Makes sense.
> VI. Examples/Tutorial
> I am not still sure about how this section should look like,
> other than we need one :).
>
Is this a client API tutorial, an administrator's tutorial, or what? Or
do we need one of each?
> VII. Appendix
>
OK.
I like this in general.
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Rajith Attapattu <ra...@gmail.com>.
Here are some general comments.
Frankly I am not too happy with the current format.
I'd like to see the following in the docs.
1. The user guide should be tied to a particular version, as we are
shipping them for each release.
2. The guide should focus on end users, not developers. So we should
get rid of all design docs.
3. Our documentation should reflect the goals, vision and direction of
the project.
a) Brokers with a common set of features
b) Management tools that work with both brokers
c) Common Client API's
d) Interoperability via examples
4. I would like to see the TOC as follows.
I. Introduction
What you have here is fine, but I am not sure about the getting
started and download stuff. I need to think about it a bit more.
II. AMQP Messaging Brokers
I think rather than having separate sections for each broker, it's
best to describe common functionality first then we can have separate
chapters for each broker.
Recently Rob Godfrey has done a tremendous amount of work to bring
the Java broker inline with the c++ broker in terms of features.
Ex. Federation, QMF support, LVQ etc... (in addition common
features include ACL, Authentication, SSL ..etc)
So perhaps the section can be organized as,
Chapter 1. Broker concepts (Federation, Security {ACL,
Authentication, SSL}, QMF, LVQ ..etc)
Chapter 2. Java Broker
Chapter 3. C++ Broker
(Chapters 2&3 describes the specifics like how to install, run, and
configure)
II. AMQP Messaging Clients
We should again explain the common concepts and vision behind the
client API's while stating that JMS and WCF are following idioms/API's
that are already defined for those domains.
The specific chapters on each client will focus on the languages
specific items like (how to open a connection, receive a message, send
a message ..etc) and the relevant configuration options.
Chapter 1. API and addressing syntax.
Chapter 2. Python Client
Chapter 3. C++ Client
Chapter 4. JMS Client
Chapter 5. WCF Client
Chapter 6. Ruby Client
III. AMQP Messaging Broker Management.
This should be a top level section on it's own rather than
anything that C++/Java broker specific. A majority of these tools can
be used against both.
We should state that our brokers can be managed using QMF (and JMX
- the Java broker directly and the C++ broker via QMan).
Chapter 1. Python management tools - (qpid-config,......)
Chapter 2. QMan.
QMF-to-JMX bridge
QMF-to-WSDM bridge
Chapter 3. Eclipse pluggins
IV. QMF
This is actually a sub project of Qpid that can be used to manage
anything. So IMO it deserves it's own section.
Chapter 1. QMF Concepts
Chapter 2. QMF C++ API
Chapter 2. QMF Python API
Chapter 4. QMF Java API
V. Testing Frameworks and Tools
Here we can talk about our testing frameworks and perf tools
VI. Examples/Tutorial
I am not still sure about how this section should look like,
other than we need one :).
VII. Appendix
Regards,
Rajith
On Tue, Mar 16, 2010 at 10:18 AM, Jonathan Robie
<jo...@redhat.com> wrote:
> I'd like feedback on the overall file structure and organization of the Qpid
> DocBook docs - is this a structure we feel comfortable adding to? Does it
> need to be changed in any way? I'd like to get that part right first.
>
> Here is the table of contents:
>
> Table of Contents
> I. Basics
> ............................................................................................................................
> 1
> 1. Apache Qpid: Open Source AMQP Messaging
> ............................................................. 3
> AMQP Messaging Brokers
> ...................................................................................
> 3
> AMQP Client APIs: C++, Java, JMS, Ruby, Python, and C#
> ...................................... 3
> Operating Systems and Platforms:
> ......................................................................... 3
> 2. AMQP (Advanced Message Queueing Protocol
> ............................................................ 5
> Download the AMQP Specifications
> ...................................................................... 5
> 3. Getting Started
> .......................................................................................................
> 7
> 4. Download Apache Qpid
> ...........................................................................................
> 9
> Production Releases
> ............................................................................................
> 9
> 0.5 Release
> ........................................................................................................
> 9
> Multiple Component Packages
> ...................................................................... 9
> Single Component Package
> .......................................................................... 9
> QpidComponents.org
> .........................................................................................
> 10
> Contributed C++ Packages
> .................................................................................
> 11
> Pre-built Linux Packages
> ............................................................................
> 11
> Windows Installer
> .....................................................................................
> 11
> Source Code Repository
> .....................................................................................
> 11
> II. AMQP Messaging Broker (Implemented in C++)
> ............................................................... 12
> 5. Running the AMQP Messaging Broker
> .................................................................... 13
> Running a Qpid C++ Broker
> ............................................................................
> 13
> Building the C++ Broker and Client Libraries
> .............................................. 13
> Running the C++ Broker
> ..........................................................................
> 13
> Most common questions getting qpidd running
> ............................................. 13
> Authentication
> ........................................................................................
> 14
> Slightly more complex configuration
> .......................................................... 15
> Loading extra modules
> ............................................................................
> 16
> Cheat Sheet for configuring Queue Options
> ......................................................... 17
> Configuring Queue Options
> ...................................................................... 17
> Cheat Sheet for configuring Exchange Options
> ..................................................... 19
> Configuring Exchange Options
> .................................................................. 19
> Using Broker Federation
> ..................................................................................
> 21
> Introduction
> ...........................................................................................
> 21
> What Is Broker Federation?
> ...................................................................... 21
> The qpid-route Utility
> ..............................................................................
> 21
> Example Scenarios
> ..................................................................................
> 27
> Advanced Topics
> ....................................................................................
> 29
> SSL
> ..............................................................................................................
> 29
> SSL How to
> ..........................................................................................
> 29
> LVQ
> ............................................................................................................
> 31
> Understanding LVQ
> ................................................................................
> 31
> LVQ semantics:
> .....................................................................................
> 31
> LVQ_NO_BROWSE semantics:
> ................................................................ 32
> Example source
> ......................................................................................
> 33
> queue state replication
> .....................................................................................
> 36
> Asynchronous Replication of Queue State
> ................................................... 36
> Starting a cluster
> ............................................................................................
> 40
> Running a Qpidd cluster
> ..........................................................................
> 40
> ACL
> .............................................................................................................
> 42
> v2 ACL file format for brokers
> ................................................................. 42
> Design Documentation
> .............................................................................
> 45
> v2 ACL User Guide
> ................................................................................
> 46
> 6. Managing the AMQP Messaging Broker
> .................................................................. 48
> Managing the C++ Broker
> ................................................................................
> 48
> Using qpid-config
> ...................................................................................
> 48
> Using qpid-route
> .....................................................................................
> 50
> Using qpid-tool
> ......................................................................................
> 51
> Using qpid-printevents
> .............................................................................
> 55
> QMan - Qpid Management bridge
> ..................................................................... 55
> QMan : Qpid Management Bridge
> ............................................................. 55
> Qpid Management Framework
> ..........................................................................
> 56
> What Is QMF
> ........................................................................................
> 56
> Getting Started with QMF
> ........................................................................ 57
> QMF Concepts
> .......................................................................................
> 57
> The QMF Protocol
> ..................................................................................
> 61
> How to Write a QMF Console
> .................................................................. 61
> How to Write a QMF Agent
> ..................................................................... 61
> Management Design notes
> ................................................................................
> 61
> Status of This Document
> ..........................................................................
> 61
> Introduction
> ...........................................................................................
> 62
> Links
> ....................................................................................................
> 62
> Management Requirements
> ....................................................................... 62
> Definition of Terms
> ................................................................................
> 63
> Operational Scenarios: Basic vs. Extended
> ................................................... 63
> Architectural Framework
> ..........................................................................
> 63
> The Management Exchange
> ...................................................................... 64
> The Protocol
> ..........................................................................................
> 65
> QMF Python Console Tutorial
> ..........................................................................
> 79
> Prerequisite - Install Qpid Messaging
> ......................................................... 79
> Synchronous Console Operations
> ............................................................... 79
> Asynchronous Console Operations
> ............................................................. 84
> Discovering what Kinds of Objects are Available
> .......................................... 88
> III. AMQP Messaging Broker (Implemented in Java)
> .............................................................. 89
> 7. General User Guides
> ..............................................................................................
> 90
> Java Broker Feature Guide
> ...............................................................................
> 90
> The Qpid pure Java broker currently supports the following
> features: ................ 90
> Qpid Java FAQ
> ..............................................................................................
> 90
> Purpose
> ...................................................................................................
> 90
> Java Environment Variables
> ............................................................................
> 100
> Setting Qpid Environment Variables
> ......................................................... 100
> Qpid Troubleshooting Guide
> ...........................................................................
> 100
> I'm getting a java.lang.UnsupportedClassVersionError when I
> try to start the
> broker. What does this mean ?
> .................................................................. 100
> I'm having a problem binding to the required host:port at
> broker startup ? ......... 101
> I'm having problems with my classpath. How can I ensure that
> my classpath is
> ok ?
> .....................................................................................................
> 101
> I can't get the broker to start. How can I diagnose the
> problem ? ..................... 101
> When I try to send messages to a queue I'm getting a error
> as the queue does not
> exist. What can I do ?
> .............................................................................
> 101
> 8. How Tos
> ............................................................................................................
> 102
> Add New Users
> ............................................................................................
> 102
> Available Password file formats
> ............................................................... 102
> Dynamic changes to password files.
> ......................................................... 103
> How password files and PrincipalDatabases relate to
> authentication
> mechanisms
> ..........................................................................................
> 104
> Configure ACLs
> ...........................................................................................
> 104
> Configure ACLs
> ...................................................................................
> 104
> Configure Java Qpid to use a SSL connection.
> .................................................... 104
> Using SSL connection with Qpid Java.
> ...................................................... 104
> Setup
> ..................................................................................................
> 104
> Performing the connection.
> ..................................................................... 105
> Configure Log4j CompositeRolling Appender
> .................................................... 105
> How to configure the CompositeRolling log4j Appender
> ............................... 105
> Configure the Broker via config.xml
> ................................................................. 107
> Broker config.xml Overview
> ................................................................... 107
> Qpid Version
> .......................................................................................
> 107
> Configure the Virtual Hosts via virtualhosts.xml
> ................................................. 107
> virtualhosts.xml Overview
> ...................................................................... 107
> Debug using log4j
> .........................................................................................
> 109
> Debugging with log4j configurations
> ........................................................ 109
> How to Tune M3 Java Broker Performance
> ....................................................... 113
> Problem Statement
> ................................................................................
> 113
> Successful Tuning Options
> ..................................................................... 113
> Next Steps
> ...........................................................................................
> 114
> Qpid Java Build How To
> ...............................................................................
> 114
> Build Instructions - General
> .................................................................... 114
> Build Instructions - Trunk
> ...................................................................... 115
> Use Priority Queues
> ......................................................................................
> 118
> General Information
> ..............................................................................
> 118
> Defining Priority Queues
> ........................................................................ 118
> Client configuration/messaging model for priority queues
> ............................. 119
> 9. Qpid JMX Management Console
> ...........................................................................
> 120
> Qpid JMX Management Console
> ..................................................................... 120
> Overview
> .............................................................................................
> 120
> 10. Management Tools
> .............................................................................................
> 135
> MessageStore Tool
> ........................................................................................
> 135
> MessageStore Tool
> ................................................................................
> 135
> Qpid Java Broker Management CLI
> ................................................................. 136
> How to build Apache Qpid CLI
> ............................................................... 136
> IV. AMQP Messaging Clients Clients
> .................................................................................
> 138
> 11. AMQP Java JMS Messaging Client
> ...................................................................... 140
> General User Guides
> ........................................................................................
> 140
> System Properties
> .................................................................................
> 140
> Connection URL Format
> ........................................................................ 143
> Binding URL Format
> .............................................................................
> 145
> AMQP Java JMS Examples
> .............................................................................
> 147
> 12. AMQP C++ Messaging Client
> .............................................................................
> 148
> User Guides
> .................................................................................................
> 148
> Examples
> .....................................................................................................
> 148
> 13. AMQP .NET Messaging Client
> ...........................................................................
> 149
> User Guides
> .................................................................................................
> 149
> Apache Qpid: Open Source AMQP Messaging - .NET User Guide
> .................. 149
> Excel AddIn
> .........................................................................................
> 164
> WCF
> ..................................................................................................
> 166
> Examples
> .....................................................................................................
> 167
> 14. AMQP Python Messaging Client
> .........................................................................
> 168
> User Guides
> .................................................................................................
> 168
> Examples
> .....................................................................................................
> 168
> PythonBrokerTest
> .........................................................................................
> 168
> Python Broker System Test Suite
> ............................................................. 168
> 15. AMQP Ruby Messaging Client
> ...........................................................................
> 169
> Examples
> .....................................................................................................
> 169
> V. Appendices
> ................................................................................................................
> 170
> 16. AMQP compatibility
> .........................................................................................
> 172
> AMQP Compatibility of Qpid releases:
> ............................................................. 172
> Interop table by AMQP specification version
> ..................................................... 173
> 17. Qpid Interoperability Documentation
> .................................................................... 174
> Qpid Interoperability Documentation
> ................................................................ 174
> SASL
> ..................................................................................................
> 174
>
>
> The table of contents is built, bottom up, from the files. Here is the file
> structure:
>
> Book.xml
> Book-Info.xml
> Introduction.xml
> AMQP.xml
> Getting-Started.xml
> Download.xml
> AMQP-Messaging-Broker-CPP.xml
> Running-CPP-Broker.xml
> Cheat-Sheet-for-configuring-Queue-Options.xml
> Cheat-Sheet-for-configuring-Exchange-Options.xml
> Using-Broker-Federation.xml
> SSL.xml
> LVQ.xml
> queue-state-replication.xml
> Starting-a-cluster.xml
> ACL.xml
> Managing-CPP-Broker.xml
> QMan-Qpid-Management-bridge.xml
> Qpid-Management-Framework.xml
> Management-Design-notes.xml
> QMF-Python-Console-Tutorial.xml
> AMQP-Messaging-Broker-Java.xml
> Java-Broker-Feature-Guide.xml
> Qpid-Java-FAQ.xml
> Java-Environment-Variables.xml
> Qpid-Troubleshooting-Guide.xml
> Add-New-Users.xml
> Configure-ACLs.xml
> Configure-Java-Qpid-to-use-a-SSL-connection.xml
> Configure-Log4j-CompositeRolling-Appender.xml
> Configure-the-Broker-via-config.xml.xml
> Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
> Debug-using-log4j.xml
> How-to-Tune-M3-Java-Broker-Performance.xml
> Qpid-Java-Build-How-To.xml
> Use-Priority-Queues.xml
> Qpid-JMX-Management-Console.xml
> Configuring-Management-Users.xml
> Configuring-Qpid-JMX-Management-Console.xml
> Management-Console-Security.xml
> Qpid-JMX-Management-Console-FAQ.xml
> Qpid-JMX-Management-Console-User-Guide.xml
> Qpid-Management-Features.xml
> MessageStore-Tool.xml
> Qpid-Java-Broker-Management-CLI.xml
> AMQP-Java-JMS-Messaging-Client.xml
> System-Properties.xml
> Connection-URL-Format.xml
> Binding-URL-Format.xml
> AMQP-C++-Messaging-Client.xml
> AMQP-.NET-Messaging-Client.xml
> NET-User-Guide.xml
> Excel-AddIn.xml
> WCF.xml
> AMQP-Python-Messaging-Client.xml
> PythonBrokerTest.xml
> AMQP-Ruby-Messaging-Client.xml
> AMQP-Compatibility.xml
> Qpid-Interoperability-Documentation.xml
>
> Does this organization work?
>
> Jonathan
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@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-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Alan Conway <ac...@redhat.com>.
On 03/16/2010 10:18 AM, Jonathan Robie wrote:
> I'd like feedback on the overall file structure and organization of the
> Qpid DocBook docs - is this a structure we feel comfortable adding to?
> Does it need to be changed in any way? I'd like to get that part right
> first.
>
We should prioritize documenting the new API in the book and also make it clear
that the old API is deprecated.
There's some content in ~/qpid/qpid/cpp/examples/messaging/readme.txt, there may
be more lying around.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Qpid docs - file structure and organization
Posted by Jonathan Robie <jo...@redhat.com>.
On 03/16/2010 10:40 AM, Steve Huston wrote:
> That organization looks good, Jonathan.
>
> It would be good, I think, to have some sort of intro client info to
> orient a new person to the general steps involved in writing a client.
> Stuff like, you need a connection, you need a session, you build
> messages, you get messages from queues, etc. Not much language-specific
> detail, but give the new person some sort of roadmap. Map the AMQP spec
> back to a messaging program developer.
>
Yes, I agree. Something like the Red Hat MRG Messaging tutorials, but
using the high level API?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
RE: Qpid docs - file structure and organization
Posted by Steve Huston <sh...@riverace.com>.
That organization looks good, Jonathan.
It would be good, I think, to have some sort of intro client info to
orient a new person to the general steps involved in writing a client.
Stuff like, you need a connection, you need a session, you build
messages, you get messages from queues, etc. Not much language-specific
detail, but give the new person some sort of roadmap. Map the AMQP spec
back to a messaging program developer.
-Steve
> -----Original Message-----
> From: Jonathan Robie [mailto:jonathan.robie@redhat.com]
> Sent: Tuesday, March 16, 2010 10:18 AM
> To: dev@qpid.apache.org
> Subject: Qpid docs - file structure and organization
>
>
> I'd like feedback on the overall file structure and
> organization of the
> Qpid DocBook docs - is this a structure we feel comfortable
> adding to?
> Does it need to be changed in any way? I'd like to get that
> part right
> first.
>
> Here is the table of contents:
>
> Table of Contents
> I. Basics
> ..............................................................
> ..............................................................
> 1
> 1. Apache Qpid: Open Source AMQP Messaging
> ............................................................. 3
> AMQP Messaging Brokers
> ..............................................................
> .....................
> 3
> AMQP Client APIs: C++, Java, JMS, Ruby, Python, and C#
> ...................................... 3
> Operating Systems and Platforms:
> ..............................................................
> ........... 3
> 2. AMQP (Advanced Message Queueing Protocol
> ............................................................ 5
> Download the AMQP Specifications
> ..............................................................
> ........ 5
> 3. Getting Started
> ..............................................................
> .........................................
> 7
> 4. Download Apache Qpid
> ..............................................................
> .............................
> 9
> Production Releases
> ..............................................................
> ..............................
> 9
> 0.5 Release
> ..............................................................
> ..........................................
> 9
> Multiple Component Packages
> ..............................................................
> ........ 9
> Single Component Package
> ..............................................................
> ............ 9
> QpidComponents.org
> ..............................................................
> ...........................
> 10
> Contributed C++ Packages
> ..............................................................
> ...................
> 11
> Pre-built Linux Packages
> ..............................................................
> ..............
> 11
> Windows Installer
> ..............................................................
> .......................
> 11
> Source Code Repository
> ..............................................................
> .......................
> 11
> II. AMQP Messaging Broker (Implemented in C++)
> ............................................................... 12
> 5. Running the AMQP Messaging Broker
> ..............................................................
> ...... 13
> Running a Qpid C++ Broker
> ..............................................................
> ..............
> 13
> Building the C++ Broker and Client Libraries
> .............................................. 13
> Running the C++ Broker
> ..............................................................
> ............
> 13
> Most common questions getting qpidd running
> ............................................. 13
> Authentication
> ..............................................................
> ..........................
> 14
> Slightly more complex configuration
> .......................................................... 15
> Loading extra modules
> ..............................................................
> ..............
> 16
> Cheat Sheet for configuring Queue Options
> ......................................................... 17
> Configuring Queue Options
> ..............................................................
> ........ 17
> Cheat Sheet for configuring Exchange Options
> ..................................................... 19
> Configuring Exchange Options
> .................................................................. 19
> Using Broker Federation
> ..............................................................
> ....................
> 21
> Introduction
> ..............................................................
> .............................
> 21
> What Is Broker Federation?
> ..............................................................
> ........ 21
> The qpid-route Utility
> ..............................................................
> ................
> 21
> Example Scenarios
> ..............................................................
> ....................
> 27
> Advanced Topics
> ..............................................................
> ......................
> 29
> SSL
> ..............................................................
> ................................................
> 29
> SSL How to
> ..............................................................
> ............................
> 29
> LVQ
> ..............................................................
> ..............................................
> 31
> Understanding LVQ
> ..............................................................
> ..................
> 31
> LVQ semantics:
> ..............................................................
> .......................
> 31
> LVQ_NO_BROWSE semantics:
> ................................................................ 32
> Example source
> ..............................................................
> ........................
> 33
> queue state replication
> ..............................................................
> .......................
> 36
> Asynchronous Replication of Queue State
> ................................................... 36
> Starting a cluster
> ..............................................................
> ..............................
> 40
> Running a Qpidd cluster
> ..............................................................
> ............
> 40
> ACL
> ..............................................................
> ...............................................
> 42
> v2 ACL file format for brokers
> ................................................................. 42
> Design Documentation
> ..............................................................
> ...............
> 45
> v2 ACL User Guide
> ..............................................................
> ..................
> 46
> 6. Managing the AMQP Messaging Broker
> .................................................................. 48
> Managing the C++ Broker
> ..............................................................
> ..................
> 48
> Using qpid-config
> ..............................................................
> .....................
> 48
> Using qpid-route
> ..............................................................
> .......................
> 50
> Using qpid-tool
> ..............................................................
> ........................
> 51
> Using qpid-printevents
> ..............................................................
> ...............
> 55
> QMan - Qpid Management bridge
> ..............................................................
> ....... 55
> QMan : Qpid Management Bridge
> ............................................................. 55
> Qpid Management Framework
> ..............................................................
> ............
> 56
> What Is QMF
> ..............................................................
> ..........................
> 56
> Getting Started with QMF
> ..............................................................
> .......... 57
> QMF Concepts
> ..............................................................
> .........................
> 57
> The QMF Protocol
> ..............................................................
> ....................
> 61
> How to Write a QMF Console
> .................................................................. 61
> How to Write a QMF Agent
> ..............................................................
> ....... 61
> Management Design notes
> ..............................................................
> ..................
> 61
> Status of This Document
> ..............................................................
> ............
> 61
> Introduction
> ..............................................................
> .............................
> 62
> Links
> ..............................................................
> ......................................
> 62
> Management Requirements
> ..............................................................
> ......... 62
> Definition of Terms
> ..............................................................
> ..................
> 63
> Operational Scenarios: Basic vs. Extended
> ................................................... 63
> Architectural Framework
> ..............................................................
> ............
> 63
> The Management Exchange
> ..............................................................
> ........ 64
> The Protocol
> ..............................................................
> ............................
> 65
> QMF Python Console Tutorial
> ..............................................................
> ............
> 79
> Prerequisite - Install Qpid Messaging
> ......................................................... 79
> Synchronous Console Operations
> ............................................................... 79
> Asynchronous Console Operations
> ............................................................. 84
> Discovering what Kinds of Objects are Available
> .......................................... 88
> III. AMQP Messaging Broker (Implemented in Java)
> .............................................................. 89
> 7. General User Guides
> ..............................................................
> ................................
> 90
> Java Broker Feature Guide
> ..............................................................
> .................
> 90
> The Qpid pure Java broker currently supports the
> following features: ................ 90
> Qpid Java FAQ
> ..............................................................
> ................................
> 90
> Purpose
> ..............................................................
> .....................................
> 90
> Java Environment Variables
> ..............................................................
> ..............
> 100
> Setting Qpid Environment Variables
> ......................................................... 100
> Qpid Troubleshooting Guide
> ..............................................................
> .............
> 100
> I'm getting a
> java.lang.UnsupportedClassVersionError
> when I try to start the
> broker. What does this mean ?
> .................................................................. 100
> I'm having a problem binding to the
> required host:port
> at broker startup ? ......... 101
> I'm having problems with my classpath. How can I
> ensure that my classpath is
> ok ?
> ..............................................................
> .......................................
> 101
> I can't get the broker to start. How can I diagnose
> the problem ? ..................... 101
> When I try to send messages to a queue I'm
> getting a
> error as the queue does not
> exist. What can I do ?
> ..............................................................
> ...............
> 101
> 8. How Tos
> ..............................................................
> ..............................................
> 102
> Add New Users
> ..............................................................
> ..............................
> 102
> Available Password file formats
> ............................................................... 102
> Dynamic changes to password files.
> ......................................................... 103
> How password files and PrincipalDatabases relate to
> authentication
> mechanisms
> ..............................................................
> ............................
> 104
> Configure ACLs
> ..............................................................
> .............................
> 104
> Configure ACLs
> ..............................................................
> .....................
> 104
> Configure Java Qpid to use a SSL connection.
> .................................................... 104
> Using SSL connection with Qpid Java.
> ...................................................... 104
> Setup
> ..............................................................
> ....................................
> 104
> Performing the connection.
> ..............................................................
> ....... 105
> Configure Log4j CompositeRolling Appender
> .................................................... 105
> How to configure the CompositeRolling log4j Appender
> ............................... 105
> Configure the Broker via config.xml
> ................................................................. 107
> Broker config.xml Overview
> ..............................................................
> ..... 107
> Qpid Version
> ..............................................................
> .........................
> 107
> Configure the Virtual Hosts via virtualhosts.xml
> ................................................. 107
> virtualhosts.xml Overview
> ..............................................................
> ........ 107
> Debug using log4j
> ..............................................................
> ...........................
> 109
> Debugging with log4j configurations
> ........................................................ 109
> How to Tune M3 Java Broker Performance
> ....................................................... 113
> Problem Statement
> ..............................................................
> ..................
> 113
> Successful Tuning Options
> ..............................................................
> ....... 113
> Next Steps
> ..............................................................
> .............................
> 114
> Qpid Java Build How To
> ..............................................................
> .................
> 114
> Build Instructions - General
> ..............................................................
> ...... 114
> Build Instructions - Trunk
> ..............................................................
> ........ 115
> Use Priority Queues
> ..............................................................
> ........................
> 118
> General Information
> ..............................................................
> ................
> 118
> Defining Priority Queues
> ..............................................................
> .......... 118
> Client configuration/messaging model for
> priority queues
> ............................. 119
> 9. Qpid JMX Management Console
> ..............................................................
> .............
> 120
> Qpid JMX Management Console
> ..............................................................
> ....... 120
> Overview
> ..............................................................
> ...............................
> 120
> 10. Management Tools
> ..............................................................
> ...............................
> 135
> MessageStore Tool
> ..............................................................
> ..........................
> 135
> MessageStore Tool
> ..............................................................
> ..................
> 135
> Qpid Java Broker Management CLI
> ................................................................. 136
> How to build Apache Qpid CLI
> ..............................................................
> . 136 IV. AMQP Messaging Clients Clients
> ..............................................................
> ...................
> 138
> 11. AMQP Java JMS Messaging Client
> ..............................................................
> ........ 140
> General User Guides
> ..............................................................
> ..........................
> 140
> System Properties
> ..............................................................
> ...................
> 140
> Connection URL Format
> ..............................................................
> .......... 143
> Binding URL Format
> ..............................................................
> ...............
> 145
> AMQP Java JMS Examples
> ..............................................................
> ...............
> 147
> 12. AMQP C++ Messaging Client
> ..............................................................
> ...............
> 148
> User Guides
> ..............................................................
> ...................................
> 148
> Examples
> ..............................................................
> .......................................
> 148
> 13. AMQP .NET Messaging Client
> ..............................................................
> .............
> 149
> User Guides
> ..............................................................
> ...................................
> 149
> Apache Qpid: Open Source AMQP Messaging - .NET User
> Guide .................. 149
> Excel AddIn
> ..............................................................
> ...........................
> 164
> WCF
> ..............................................................
> ....................................
> 166
> Examples
> ..............................................................
> .......................................
> 167
> 14. AMQP Python Messaging Client
> ..............................................................
> ........... 168
> User Guides
> ..............................................................
> ...................................
> 168
> Examples
> ..............................................................
> .......................................
> 168
> PythonBrokerTest
> ..............................................................
> ...........................
> 168
> Python Broker System Test Suite
> ............................................................. 168
> 15. AMQP Ruby Messaging Client
> ..............................................................
> .............
> 169
> Examples
> ..............................................................
> .......................................
> 169
> V. Appendices
> ..............................................................
> ..................................................
> 170
> 16. AMQP compatibility
> ..............................................................
> ...........................
> 172
> AMQP Compatibility of Qpid releases:
> ............................................................. 172
> Interop table by AMQP specification version
> ..................................................... 173
> 17. Qpid Interoperability Documentation
> ..............................................................
> ...... 174
> Qpid Interoperability Documentation
> ................................................................ 174
> SASL
> ..............................................................
> ....................................
> 174
>
>
> The table of contents is built, bottom up, from the files.
> Here is the
> file structure:
>
> Book.xml
> Book-Info.xml
> Introduction.xml
> AMQP.xml
> Getting-Started.xml
> Download.xml
> AMQP-Messaging-Broker-CPP.xml
> Running-CPP-Broker.xml
> Cheat-Sheet-for-configuring-Queue-Options.xml
> Cheat-Sheet-for-configuring-Exchange-Options.xml
> Using-Broker-Federation.xml
> SSL.xml
> LVQ.xml
> queue-state-replication.xml
> Starting-a-cluster.xml
> ACL.xml
> Managing-CPP-Broker.xml
> QMan-Qpid-Management-bridge.xml
> Qpid-Management-Framework.xml
> Management-Design-notes.xml
> QMF-Python-Console-Tutorial.xml
> AMQP-Messaging-Broker-Java.xml
> Java-Broker-Feature-Guide.xml
> Qpid-Java-FAQ.xml
> Java-Environment-Variables.xml
> Qpid-Troubleshooting-Guide.xml
> Add-New-Users.xml
> Configure-ACLs.xml
> Configure-Java-Qpid-to-use-a-SSL-connection.xml
> Configure-Log4j-CompositeRolling-Appender.xml
> Configure-the-Broker-via-config.xml.xml
> Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
> Debug-using-log4j.xml
> How-to-Tune-M3-Java-Broker-Performance.xml
> Qpid-Java-Build-How-To.xml
> Use-Priority-Queues.xml
> Qpid-JMX-Management-Console.xml
> Configuring-Management-Users.xml
> Configuring-Qpid-JMX-Management-Console.xml
> Management-Console-Security.xml
> Qpid-JMX-Management-Console-FAQ.xml
> Qpid-JMX-Management-Console-User-Guide.xml
> Qpid-Management-Features.xml
> MessageStore-Tool.xml
> Qpid-Java-Broker-Management-CLI.xml
> AMQP-Java-JMS-Messaging-Client.xml
> System-Properties.xml
> Connection-URL-Format.xml
> Binding-URL-Format.xml
> AMQP-C++-Messaging-Client.xml
> AMQP-.NET-Messaging-Client.xml
> NET-User-Guide.xml
> Excel-AddIn.xml
> WCF.xml
> AMQP-Python-Messaging-Client.xml
> PythonBrokerTest.xml
> AMQP-Ruby-Messaging-Client.xml
> AMQP-Compatibility.xml
> Qpid-Interoperability-Documentation.xml
>
> Does this organization work?
>
> Jonathan
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org