A. I tried the proposed site with the goal of writing a hello world from scratch using proton.
1. The python documentation is very welcoming. Nav to home -> Build AMQP applications, Qpid Proton -> Python API reference Goes to a page that provides the highest level orientation with clear descriptions. 2. The Java documentation seems well organized but I haven't tried to use it much. 3. The C API is sparse. Nav to home -> Build AMQP applications Qpid Proton -> C API reference This dumps into Files, File List, almost like 'ls' output. Clicking on any file shows auto-generated diagrams and file details but where's the API? The Files pages mostly show no more comments or clues than reading the raw sources themselves. [Suggestion] For the C API a better starting point would be the Modules tree. The modules entries have more detailed descriptions and type documentation that users need to see. B. The general organization is OK. Finally seeing qpid.client called out as deprecated. C. Lots of links are dead. Is that an artifact of references to proton 0.9 that doesn't exist yet? ----- Original Message ----- > From: "Alan Conway" <[email protected]> > To: "dev" <[email protected]> > Sent: Friday, March 27, 2015 11:00:01 AM > Subject: Feedback requested: Qpid web site changes > > Justin has been working on an improved website, he's asked me to push > the changes in in his absence. (This is in addition to the JMS changes > that Robbie is working on.) Take a browse at: > > http://people.apache.org/~jross/qpid-site/test/ > > The site is (I find anway) cleaner and more navigable, with a stronger > focus on "Qpid components". > > Summary: > - Cleaner homepage, but still has one click to all useful info. > - Emphasise Proton over old messaging API on homepage. Messaging API > still fully covered in Components. > - Stronger organization around "components", more consistent > organization into APIs and servers+tools. > - Very handy dashboard for releases and issues. > > Apologies to Justin if I missed any important changes, check it out for > yourself. > > I'll incorporate improvements as I hear them. I noticed some broken > links on the Documentation page which I will fix, shout if you see > others. > > I there are no objections within a week I'll commit this change. > > Source of changes is at: > > https://github.com/alanconway/qpid-site-next > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > > --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
