Hi Martin

This is an excellent tutorial you have started to write. This is really great 
that it starts from the top how to setup a project with pom.xml and its 
dependencies and all the stuff that can be tricky to get right at start.

And yes we would love a more elaborate example that doesn't just focus on  tidy 
bits and bolts how to use a single component as they current ones mostly does.

Your tutorial is really a great giant leap to improve the documentation and 
understanding how to use Camel.

Please keep it coming. We will for sure help where we can with e.g. proof 
reading and including your hard work in the distribution.


Med venlig hilsen
 
Claus Ibsen
......................................
Silverbullet
Skovsgårdsvænget 21
8362 Hørning
Tlf. +45 2962 7576
Web: www.silverbullet.dk
-----Original Message-----
From: Martin Gilday [mailto:[EMAIL PROTECTED] 
Sent: 16. april 2008 11:58
To: [email protected]
Subject: Improving the documentation for novices

Hi,

I have been working with Camel for a couple of weeks now and would like
to share my experiences of the documentation and learning curve.  I have
found that the documentation is of a high standard and a very string
effort to ensure that all components are covered.  The problem I had
with approaching it is that it is badly structured and hard to know what
to read first when you are a beginner.  These problems have been
mentioned in the 'Book in One Page'.  However I only found this after a
week, and once I did it really helped me understand Camel, as there is a
lot of good information in the opening section not found on the rest of
the site, and gives an ordering of what you need to know.

Ideas we could try:
* Give more prominance to the 'Book in One Page'[1].  Place a link from
the home page to it, or list it on the side bar under the documentation
heading.
* Create a tutorial which shows an example Camel project whilst also
explaining how Camel works and its concepts while the user is writing
it.  There are already a number of examples with explanations but they
are small and independent and for the most part assume the reader has
understood Camel architecture and terminology.  I think by combining
examples with the architecture will help novices 'get' Camel quicker.  I
have attempted to start such a tutorial [2] which guides a user through
creating a Camel request/reply project using Spring remoting.  However
as I am really not a technical writer nor knowledgable about Camel it
still needs embellishing with what is happening at each stage.  I do
think a reasonable outline is there of what I would like to have seen
when I first approached Camel.  I would appreciate any additions,
corrections or feedback.

[1] http://activemq.apache.org/camel/book-in-one-page.html
[2]
http://cwiki.apache.org/confluence/display/CAMEL/Tutorial-JmsRemoting

What do the Camel team think about these ideas?

Thanks,
Martin.

Reply via email to