You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@servicemix.apache.org by Gert Vanthienen <ge...@skynet.be> on 2007/05/29 23:05:37 UTC
Getting started guide
L.S.,
After having followed the user mailing list for a while, it seems that
it's quite a steep learning curve to get started with ServiceMix.
I would like to add a tutorial or getting started guide to the website,
just guiding a new user through the existing documentation and trying to
explain some key concepts on the way. Something like...
# starting the container and connect to it using JMX
# installing some components and deploying e.g. the wsdl-first example
[to explain e.g. components, service assembly, service unit]
# building a simple SA, e.g. re-using the 'File binding' page [to
explain about the maven archetypes]
# building e.g. the protocol bridge example to explain about message
exchange patterns, routing, ...
Would this be a worthwhile addition or are there other areas in the
documentation that need work more urgently? Are there any other topics
to include in this guided tour?
Regards,
Gert
Re: Getting started guide
Posted by Gert Vanthienen <ge...@skynet.be>.
Eduardo,
I have started working on it today, feel free to help out
whenever/wherever you can... I have added it as Tutorial (in progress)
on http://cwiki.apache.org/confluence/display/SM/Sandbox
A lot of the information is already in the wiki, I just want to create a
step-by-step tutorial to get people started off the right way. Instead
of doing copy-paste, I would suggest to 'refactor' the pages and use
{include} where appropriate (e.g. starting ServiceMix)
Gert
Eduardo de Vera wrote:
> Bravo! I was waiting for something like this to happen sooner or later. I
> would love to contribute on my spare time.
>
> 2007/5/29, Gert Vanthienen <ge...@skynet.be>:
>>
>> L.S.,
>>
>>
>> After having followed the user mailing list for a while, it seems that
>> it's quite a steep learning curve to get started with ServiceMix.
>> I would like to add a tutorial or getting started guide to the website,
>> just guiding a new user through the existing documentation and trying to
>> explain some key concepts on the way. Something like...
>> # starting the container and connect to it using JMX
>> # installing some components and deploying e.g. the wsdl-first example
>> [to explain e.g. components, service assembly, service unit]
>> # building a simple SA, e.g. re-using the 'File binding' page [to
>> explain about the maven archetypes]
>> # building e.g. the protocol bridge example to explain about message
>> exchange patterns, routing, ...
>>
>> Would this be a worthwhile addition or are there other areas in the
>> documentation that need work more urgently? Are there any other topics
>> to include in this guided tour?
>>
>>
>> Regards,
>>
>> Gert
>>
>
>
>
Re: Getting started guide
Posted by Eduardo de Vera <et...@gmail.com>.
Bravo! I was waiting for something like this to happen sooner or later. I
would love to contribute on my spare time.
2007/5/29, Gert Vanthienen <ge...@skynet.be>:
>
> L.S.,
>
>
> After having followed the user mailing list for a while, it seems that
> it's quite a steep learning curve to get started with ServiceMix.
> I would like to add a tutorial or getting started guide to the website,
> just guiding a new user through the existing documentation and trying to
> explain some key concepts on the way. Something like...
> # starting the container and connect to it using JMX
> # installing some components and deploying e.g. the wsdl-first example
> [to explain e.g. components, service assembly, service unit]
> # building a simple SA, e.g. re-using the 'File binding' page [to
> explain about the maven archetypes]
> # building e.g. the protocol bridge example to explain about message
> exchange patterns, routing, ...
>
> Would this be a worthwhile addition or are there other areas in the
> documentation that need work more urgently? Are there any other topics
> to include in this guided tour?
>
>
> Regards,
>
> Gert
>
--
Eduardo de Vera
Sun Certified Programmer for the Java 2 Platform 1.4
blog -> http://blogandshare.blogspot.com
Re: Getting started guide
Posted by Bummer <sa...@gmail.com>.
Awesome !!! Great !!!
JCA related(Using jencks, XA(2pc), restoring, Connecting DB/MQ other than
ActiveMQ, ) stuff would be really great.
Since those issues are the things that we are currently using right now.
Alos I was looking for samples regarding EPR (dynamic endpoint resolution).
Thanks a lot. I really appreciated.
Gert Vanthienen wrote:
>
> L.S.,
>
>
> After having followed the user mailing list for a while, it seems that
> it's quite a steep learning curve to get started with ServiceMix.
> I would like to add a tutorial or getting started guide to the website,
> just guiding a new user through the existing documentation and trying to
> explain some key concepts on the way. Something like...
> # starting the container and connect to it using JMX
> # installing some components and deploying e.g. the wsdl-first example
> [to explain e.g. components, service assembly, service unit]
> # building a simple SA, e.g. re-using the 'File binding' page [to
> explain about the maven archetypes]
> # building e.g. the protocol bridge example to explain about message
> exchange patterns, routing, ...
>
> Would this be a worthwhile addition or are there other areas in the
> documentation that need work more urgently? Are there any other topics
> to include in this guided tour?
>
>
> Regards,
>
> Gert
>
>
--
View this message in context: http://www.nabble.com/Getting-started-guide-tf3836548s12049.html#a10906830
Sent from the ServiceMix - Dev mailing list archive at Nabble.com.
Re: Getting started guide
Posted by Bruce Snyder <br...@gmail.com>.
On 6/11/07, Gert Vanthienen <ge...@skynet.be> wrote:
> L.S.,
>
>
> I have made some changes to this tutorial:
> - added a section on Installing ServiceMix
> - added some information about SUs
> - tried to clarify why the client.html is being used
> - added header/footer {scrollbar}s
> - tried to elaborate on the dependency between a SU and a JBI component.
>
> On the exercise page, we already installed a SA without the right
> components being available, so people should be aware of the fact that
> ServiceMix tells you about this from there. Perhaps I haven't made it
> clear enough...?
>
> I also tried to work out the structure you were describing on
> http://cwiki.apache.org/confluence/x/ON4, with different levels of
> tutorial complexity.
>
> Any additional comment?
This looks very good, Gert. Now we just need to do this for all the
examples and continue to come up with new use cases for examples. This
will help us to create a a type of cookbook. And speaking of use
cases, we need to make sure to document the use case for each example
that we're documenting.
Again, nice work Gert!
Bruce
--
perl -e 'print unpack("u30","D0G)U8V4\@4VYY9&5R\"F)R=6-E+G-N>61E<D\!G;6%I;\"YC;VT*"
);'
Apache Geronimo - http://geronimo.apache.org/
Apache ActiveMQ - http://activemq.org/
Apache ServiceMix - http://servicemix.org/
Castor - http://castor.org/
Re: Getting started guide
Posted by Gert Vanthienen <ge...@skynet.be>.
L.S.,
I have made some changes to this tutorial:
- added a section on Installing ServiceMix
- added some information about SUs
- tried to clarify why the client.html is being used
- added header/footer {scrollbar}s
- tried to elaborate on the dependency between a SU and a JBI component.
On the exercise page, we already installed a SA without the right
components being available, so people should be aware of the fact that
ServiceMix tells you about this from there. Perhaps I haven't made it
clear enough...?
I also tried to work out the structure you were describing on
http://cwiki.apache.org/confluence/x/ON4, with different levels of
tutorial complexity.
Any additional comment?
Gert
Bruce Snyder wrote:
> On 6/7/07, Gert Vanthienen <ge...@skynet.be> wrote:
>>
>> Bruce,
>>
>> I've created a first tutorial, a guided tour of starting, installing,
>> deploying and testing a first application and, more importantly, a quick
>> introduction some JBI concepts (service assembly, service unit, ...). It
>> isn't completely done yet, but it already shows the intention. Is
>> this what
>> you had in mind?
>>
>> For the second tutorial, I would like to focus on the Maven tooling and
>> archetypes. Any suggestions on that topic?
>
> This is a great start, Gert! Overall this is a wonderful start. I hope
> to be able to create a whole series of these guides to help users get
> started easier. Below are my comments:
>
> - Provide a headding to the section about installing ServiceMix to
> properly identity it. Right now it's under a heading named Content
> which isn't very descriptive.
>
> - Make sure to describe both SAs and SUs. Right now SUs are not
> described at all. This is easy to do because there are already FAQ
> entries about SAs and SUs that can be referenced for this.
>
> - We should break up the whole guide into sections like Beginner,
> Intermediate and Advanced. This will allow us to address more complex
> topics without confusing beginners. E.g., In the beginner JMX
> tutorial, we only address connecting to a local instance of SMX
> whereas an intermediate version would describe how to connect to
> multiple remote instances of SMX and an advanced version might go into
> code level use of JMX, all of which are cross-linked.
>
> - Be very clear about the component dependencies for deploying the
> example. It might be a good idea to demonstrate that SMX will tell you
> when a component is missing.
>
> - Provide a better description about what the client.html file is
> actually doing to invoke the service (i.e., it is sending an XML
> message to the URL where the service is exposed). Upon first using
> SMX, many people assume that when configuring the locationURI for
> servicemix-http that you can simply visit that URL in a browser to use
> it and this is not true. We need to explain that an XML message must
> be sent to this URL.
>
> - The header and footer with the arrows for navigation are missing
> from most of the pages. Please make sure to add them.
>
> Again, very nice work, Gert. My comments are only meant to be constructive.
>
> Bruce
Re: Getting started guide
Posted by Bruce Snyder <br...@gmail.com>.
On 6/7/07, Gert Vanthienen <ge...@skynet.be> wrote:
>
> Bruce,
>
> I've created a first tutorial, a guided tour of starting, installing,
> deploying and testing a first application and, more importantly, a quick
> introduction some JBI concepts (service assembly, service unit, ...). It
> isn't completely done yet, but it already shows the intention. Is this what
> you had in mind?
>
> For the second tutorial, I would like to focus on the Maven tooling and
> archetypes. Any suggestions on that topic?
This is a great start, Gert! Overall this is a wonderful start. I hope
to be able to create a whole series of these guides to help users get
started easier. Below are my comments:
- Provide a headding to the section about installing ServiceMix to
properly identity it. Right now it's under a heading named Content
which isn't very descriptive.
- Make sure to describe both SAs and SUs. Right now SUs are not
described at all. This is easy to do because there are already FAQ
entries about SAs and SUs that can be referenced for this.
- We should break up the whole guide into sections like Beginner,
Intermediate and Advanced. This will allow us to address more complex
topics without confusing beginners. E.g., In the beginner JMX
tutorial, we only address connecting to a local instance of SMX
whereas an intermediate version would describe how to connect to
multiple remote instances of SMX and an advanced version might go into
code level use of JMX, all of which are cross-linked.
- Be very clear about the component dependencies for deploying the
example. It might be a good idea to demonstrate that SMX will tell you
when a component is missing.
- Provide a better description about what the client.html file is
actually doing to invoke the service (i.e., it is sending an XML
message to the URL where the service is exposed). Upon first using
SMX, many people assume that when configuring the locationURI for
servicemix-http that you can simply visit that URL in a browser to use
it and this is not true. We need to explain that an XML message must
be sent to this URL.
- The header and footer with the arrows for navigation are missing
from most of the pages. Please make sure to add them.
Again, very nice work, Gert. My comments are only meant to be constructive.
Bruce
--
perl -e 'print unpack("u30","D0G)U8V4\@4VYY9&5R\"F)R=6-E+G-N>61E<D\!G;6%I;\"YC;VT*"
);'
Apache Geronimo - http://geronimo.apache.org/
Apache ActiveMQ - http://activemq.org/
Apache ServiceMix - http://servicemix.org/
Castor - http://castor.org/
Re: Getting started guide
Posted by Gert Vanthienen <ge...@skynet.be>.
Bruce,
I've created a first tutorial, a guided tour of starting, installing,
deploying and testing a first application and, more importantly, a quick
introduction some JBI concepts (service assembly, service unit, ...). It
isn't completely done yet, but it already shows the intention. Is this what
you had in mind?
For the second tutorial, I would like to focus on the Maven tooling and
archetypes. Any suggestions on that topic?
Regards,
Gert
bsnyder wrote:
>
> On 5/29/07, Gert Vanthienen <ge...@skynet.be> wrote:
>> L.S.,
>>
>>
>> After having followed the user mailing list for a while, it seems that
>> it's quite a steep learning curve to get started with ServiceMix.
>> I would like to add a tutorial or getting started guide to the website,
>> just guiding a new user through the existing documentation and trying to
>> explain some key concepts on the way. Something like...
>> # starting the container and connect to it using JMX
>> # installing some components and deploying e.g. the wsdl-first example
>> [to explain e.g. components, service assembly, service unit]
>> # building a simple SA, e.g. re-using the 'File binding' page [to
>> explain about the maven archetypes]
>> # building e.g. the protocol bridge example to explain about message
>> exchange patterns, routing, ...
>>
>> Would this be a worthwhile addition or are there other areas in the
>> documentation that need work more urgently? Are there any other topics
>> to include in this guided tour?
>
> Very nice work Gert! I'm excited that someone else is interested to
> help develop more docs - yay!
>
> There are certainly a lot of concepts with which you must be familiar
> in order to dive in. I had to explain this to a friend recently and he
> was quite overwhelmed at first.
>
> I have had this task in mind for some time and I just haven't had the
> time to spend on it yet. I wrote the hello world tutorials on building
> components and those are still not 100% complete :-( - if only there
> were 30 hours in a day! So, yes, yes - let's create some simple
> tutorials to help folks get started!
>
> What I've had in mind is a Getting Started Guide - a set of exercises
> to help users become familiar with ServiceMix, including ActiveMQ, in
> the most expedient manner possible. I'd like to provide a five minute
> version and then much more detailed version, keeping in mind that they
> must be from a user's perspective, not a developer of ServiceMix.
>
> The most basic tutorials are the most in demand right now such as,
> starting ServiceMix, deploying and testing some of the examples, how
> to send test messages using SoapUI and otherwise, walking users
> through a step-by-step tutorial of building their own flow using
> components that come with ServiceMix.
>
> Before diving right in without a plan, let's at least outline the
> exercises we would like to create. That way work on different
> exercises can take place concurrently and nobody is hindered by
> another exercises level of completion. Below is a suggested list:
>
> 1) Starting SMX
> 2) Explain components (e.g., explain and demo both types from a *user*
> perspective)
> 3) Using JMX with SMX via Jconsole (e.g., poke around a bit)
> 4) Explain and run SMX examples (e.g., explain how to deploy and how
> the flow through SUs works)
> 5) Developing and testing your own SUs (e.g., this should be broken up
> into multiple exercises that build upon one another so that we take
> users through a progression that becomes more complex as they go)
>
> This is just a five minute brain dump - let's work on this together
> via the wiki.
>
> Bruce
> --
> perl -e 'print
> unpack("u30","D0G)U8V4\@4VYY9&5R\"F)R=6-E+G-N>61E<D\!G;6%I;\"YC;VT*"
> );'
>
> Apache Geronimo - http://geronimo.apache.org/
> Apache ActiveMQ - http://activemq.org/
> Apache ServiceMix - http://servicemix.org/
> Castor - http://castor.org/
>
>
--
View this message in context: http://www.nabble.com/Getting-started-guide-tf3836548s12049.html#a11015781
Sent from the ServiceMix - Dev mailing list archive at Nabble.com.
Re: Getting started guide
Posted by Bruce Snyder <br...@gmail.com>.
On 5/29/07, Gert Vanthienen <ge...@skynet.be> wrote:
> L.S.,
>
>
> After having followed the user mailing list for a while, it seems that
> it's quite a steep learning curve to get started with ServiceMix.
> I would like to add a tutorial or getting started guide to the website,
> just guiding a new user through the existing documentation and trying to
> explain some key concepts on the way. Something like...
> # starting the container and connect to it using JMX
> # installing some components and deploying e.g. the wsdl-first example
> [to explain e.g. components, service assembly, service unit]
> # building a simple SA, e.g. re-using the 'File binding' page [to
> explain about the maven archetypes]
> # building e.g. the protocol bridge example to explain about message
> exchange patterns, routing, ...
>
> Would this be a worthwhile addition or are there other areas in the
> documentation that need work more urgently? Are there any other topics
> to include in this guided tour?
Very nice work Gert! I'm excited that someone else is interested to
help develop more docs - yay!
There are certainly a lot of concepts with which you must be familiar
in order to dive in. I had to explain this to a friend recently and he
was quite overwhelmed at first.
I have had this task in mind for some time and I just haven't had the
time to spend on it yet. I wrote the hello world tutorials on building
components and those are still not 100% complete :-( - if only there
were 30 hours in a day! So, yes, yes - let's create some simple
tutorials to help folks get started!
What I've had in mind is a Getting Started Guide - a set of exercises
to help users become familiar with ServiceMix, including ActiveMQ, in
the most expedient manner possible. I'd like to provide a five minute
version and then much more detailed version, keeping in mind that they
must be from a user's perspective, not a developer of ServiceMix.
The most basic tutorials are the most in demand right now such as,
starting ServiceMix, deploying and testing some of the examples, how
to send test messages using SoapUI and otherwise, walking users
through a step-by-step tutorial of building their own flow using
components that come with ServiceMix.
Before diving right in without a plan, let's at least outline the
exercises we would like to create. That way work on different
exercises can take place concurrently and nobody is hindered by
another exercises level of completion. Below is a suggested list:
1) Starting SMX
2) Explain components (e.g., explain and demo both types from a *user*
perspective)
3) Using JMX with SMX via Jconsole (e.g., poke around a bit)
4) Explain and run SMX examples (e.g., explain how to deploy and how
the flow through SUs works)
5) Developing and testing your own SUs (e.g., this should be broken up
into multiple exercises that build upon one another so that we take
users through a progression that becomes more complex as they go)
This is just a five minute brain dump - let's work on this together
via the wiki.
Bruce
--
perl -e 'print unpack("u30","D0G)U8V4\@4VYY9&5R\"F)R=6-E+G-N>61E<D\!G;6%I;\"YC;VT*"
);'
Apache Geronimo - http://geronimo.apache.org/
Apache ActiveMQ - http://activemq.org/
Apache ServiceMix - http://servicemix.org/
Castor - http://castor.org/