synapse-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Paul Fremantle" <pzf...@gmail.com>
Subject Re: Improving our docs, and first user experience
Date Mon, 02 Oct 2006 22:16:24 GMT
Tijs

I think this is a good starting point.

What about the format of the User Guide? I think that one of the
inhibitors we have is the lack of a well laid out website.

Personally I like the Spring Framework manual. Any other good
resources we could emulate?

Paul

On 10/2/06, Tijs Rademakers <t.rademakers@chello.nl> wrote:
>
>
>
>
> I was thinking about the following TOC for the Synapse user guide:
>
>
>
> Introduction
>
>             What is Synapse?
>
>             Explain different deployment models
>
>             Installation
>
>             Starting Synapse
>
> Build a simple mediation
>
>             The basics of the Synapse Configuration Language
>
>             How to write a mediation flow?
>
>             Deploying the mediation flow
>
> Examples
>
> Build a validation mediation flow
>
> Build a transformation mediation flow
>
> Routing the message to the right endpoint
>
> Advanced mediation scenarios
>
>             WS-Security example
>
>             WS-Reliable Messaging example
>
> Extending Synapse
>
>             Using the Class mediator
>
>             Developing your own mediator
>
>             Developing a Spring mediator
>
>
>
> The examples should be based on a simple business scenario to my opinion,
> like for example buying a book.
>
> Then we can make examples with search for a particular book, requesting
> details of a book based on an ISBN, and buying the book.
>
> Let me know if you think this is going to the right direction.
>
>
>
> Tijs
>
>
>
>
>
> -----Oorspronkelijk bericht-----
>  Van: Asankha C. Perera [mailto:asankha@wso2.com]
>  Verzonden: zaterdag 30 september 2006 19:39
>
>  Aan: synapse-dev@ws.apache.org
>  Onderwerp: Re: Improving our docs, and first user experience
>
>
>
>
> Hi Tijs
>
>  As a user of Synapse, could you suggest a format/TOC for a Synapse user
> guide as an initial step? I would then add more topics which you may not
> have come across yet (e.g. Dynamic sequences, Policy stuff etc) Then we
> could go into writing the actual content for these. I would like to use a
> simple set of good examples to demonstrate and follow through with the text
> - any suggestions on this aspect is also good. I would assume that as a
> "user" you would have encountered some issues which people like us may fail
> to notice the importance of, and would thus like to hear about your
> suggestions.
>
>  thanks
>  asankha
>
>  t.rademakers@chello.nl wrote: Paul, Asankha,
>
> As I posted earlier on this mailinglist, I am working together with a
> colleague on a book about Enterprise Integration Patterns where we use
> Synapse for the web service implementation. I think we already have a good
> introduction about Synapse with examples.
> So the suggestion from Asankha to make a Axis2 alike user guide with a test
> repository so one can directly run the examples is great to me.
> I would be willing to help create an user guide with examples with input
> from the Synapse developers.
>
> Tijs
>
>
>
> van: "Asankha C. Perera" <asankha@wso2.com>
> datum: 2006/09/29 Fri PM 01:50:26 MEST
> aan: synapse-dev@ws.apache.org
> onderwerp: Re: Improving our docs, and first user experience
>
> Paul
>
> Maybe something like the Axis2 user guide with a *good* set of
> examples..? It would also be good to ship a test repository for an Axis2
> instance against which these good examples could be directly run by
> someone who downloads this.
>
> asankha
>
> Paul Fremantle wrote:
>
>
> I think we need to make it easier to get started with Synapse.
>
> Any suggestions? Any volunteers?
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail:
> synapse-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: synapse-dev-help@ws.apache.org
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail:
> synapse-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: synapse-dev-help@ws.apache.org
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail:
> synapse-dev-unsubscribe@ws.apache.org For additional
> commands, e-mail: synapse-dev-help@ws.apache.org


-- 
Paul Fremantle
VP/Technology, WSO2 and OASIS WS-RX TC Co-chair

http://bloglines.com/blog/paulfremantle
paul@wso2.com

"Oxygenating the Web Service Platform", www.wso2.com

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


Mime
View raw message