You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by Ajith Ranabahu <aj...@gmail.com> on 2007/06/16 15:44:34 UTC

[Axis2] Quick start guide for Axis2

Hi,
I've sent this as a reply to one of the conversations yesterday but
this seems worth more interaction from the community. So here is our
discussion on user documentation

We were discussing the user guide during the hackathon .The general
consensus was that the current documentation lacks a 'quick starter
guide'. Right now one has
to scan through at least 4 pages to get to the first code block which
will be annoying if you are looking to use Axis2 quickly [Which is the
majority case]. Most of the OSS projects (and even products!) tend to
have a quick starter guide
which is a one page guide of doing the most common tasks. This is
lacking in Axis2 and we ended up outlining this quick starter guide.
After all the quality matters more than the quantity in this case.

The outline for this quick starter guide  is at
http://wiki.apache.org/ws/FrontPage/Axis2/userguide. All o you are
welcome to let us know what you think about it. The goal is to create
a 10 minute one page guide to Axis2 (which explains the basics ) and
we suppose that will be the most used (and probably the most needed at
this point) piece of documentation for Axis2.
-- 
Ajith Ranabahu

---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org


Re: [Axis2] Quick start guide for Axis2

Posted by Sanjiva Weerawarana <sa...@opensource.lk>.
I'm of two minds. The world finally seems to be slowly getting past the 
"just drop Java in and make services" mantra. However, many beginners 
still start that way because they literally do no work to make services.

So I don't mind leaving it but we need to make some comments about the 
limitations of the approach. Maybe the quick start should also have a 
simple service that processes Axiom directly too?

Sanjiva.

Dennis Sosnoski wrote:
> I'm personally not convinced that this is a good approach, since it 
> starts users off on the wrong path. The whole POJO approach, while great 
> for demos, is fundamentally limited and certainly not a good approach to 
> use in real web services. So should it be the first thing users see?
> 
>  - Dennis
> 

-- 
Sanjiva Weerawarana, Ph.D.
Founder & Director; Lanka Software Foundation; http://www.opensource.lk/
Founder, Chairman & CEO; WSO2, Inc.; http://www.wso2.com/
Director; Open Source Initiative; http://www.opensource.org/
Member; Apache Software Foundation; http://www.apache.org/
Visiting Lecturer; University of Moratuwa; http://www.cse.mrt.ac.lk/

---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org


Re: [Axis2] Quick start guide for Axis2

Posted by Dennis Sosnoski <dm...@sosnoski.com>.
I'm personally not convinced that this is a good approach, since it 
starts users off on the wrong path. The whole POJO approach, while great 
for demos, is fundamentally limited and certainly not a good approach to 
use in real web services. So should it be the first thing users see?

  - Dennis

-- 
Dennis M. Sosnoski
SOA and Web Services in Java
Axis2 Training and Consulting
http://www.sosnoski.com - http://www.sosnoski.co.nz
Seattle, WA +1-425-939-0576 - Wellington, NZ +64-4-298-6117



Ajith Ranabahu wrote:
> Hi,
> I've sent this as a reply to one of the conversations yesterday but
> this seems worth more interaction from the community. So here is our
> discussion on user documentation
>
> We were discussing the user guide during the hackathon .The general
> consensus was that the current documentation lacks a 'quick starter
> guide'. Right now one has
> to scan through at least 4 pages to get to the first code block which
> will be annoying if you are looking to use Axis2 quickly [Which is the
> majority case]. Most of the OSS projects (and even products!) tend to
> have a quick starter guide
> which is a one page guide of doing the most common tasks. This is
> lacking in Axis2 and we ended up outlining this quick starter guide.
> After all the quality matters more than the quantity in this case.
>
> The outline for this quick starter guide  is at
> http://wiki.apache.org/ws/FrontPage/Axis2/userguide. All o you are
> welcome to let us know what you think about it. The goal is to create
> a 10 minute one page guide to Axis2 (which explains the basics ) and
> we suppose that will be the most used (and probably the most needed at
> this point) piece of documentation for Axis2.

---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org