Hi Shelita,
I'd like to partner with you on writing some documentation and had also
started a page on the wiki @
http://cwiki.apache.org/confluence/display/TUSCANY/Building+SCA+for+Javawhich
has some overlap with Raymonds more recent addition.
How about we break the getting starting down into a number of smaller pages
so we can work on them more easily. I propose:
User Guide
+ Getting Tuscnay's Java SCA
+ Choosing between a package runtime and building your own
+ Downloading and installing a release
+ (use the the approach I'm experimenting with @
http://www.mail-archive.com/tuscany-dev%40ws.apache.org/msg13707.html)
+ Setting up a build environment
+ Choosing a source / understanding the source tree
+ Building - which bits to build
+ Debugging build issues
+ Build tips (eg. use of mvn -fn to continue building
despite test case failures)
+ Setting up an "SCA Developer" environment (cover both command line and
IDEs (Eclipse and others)) suitable for a user of Tuscany (as opposed to a
developer of)
+ Developing a simple SCA composite containing a single component
+ Initial project setup (is there an alternative to maven ?)
+ Developing a simple component
+ Unit testing and debugging a component
+ Composing components into composites
+ Exposing the composite to the outside world (define the
service binding)
+ Web Services, JMS etc
+ Resolving dependencies not contained in the composite
(defining the reference bindings)
+ Web Services, JMS - others ?
+ Reusing components in composites
+ Deploying to server runtime (eg. tomcat & geronimo ?)
( + Managing / monitor / changing components & composites )
...
I think it might also bring up some interesting things to consider... for
example, "How can I reuse components in a composite without copying it from
another project ?"
If folks agree with this structure (or similar) then I'll go ahead and
create it - I think it would be a good idea to agree some structure upfront
to avoid duplication (which seems likely unless we have one author).
WDYT ?
Dan
On 07/02/07, Raymond Feng <[EMAIL PROTECTED]> wrote:
Hi,
I just added a draft @
http://cwiki.apache.org/confluence/display/TUSCANY/Getting+Started. We
might
be able to use it as a starting point and add more meat into it to help
new
users understand the basic concepts, steps and tools to develop a simple
SCA
application with Tuscany.
Thanks,
Raymond
----- Original Message -----
From: "haleh mahbod" <[EMAIL PROTECTED]>
To: <tuscany-dev@ws.apache.org>
Sent: Wednesday, February 07, 2007 11:33 AM
Subject: Re: Suggestions for Tuscany SCA documenation?
> Hi Shelita,
> Welcome to Tuscany. We definitly need help with documentation :)
>
> A starting point might be a user giude on how to develop a simple SCA
> application. This document can then incrementally grow to cover more
> advanced topics.
>
> Another project might be to work on an SCA user doc with examples. This
> would provide a quick reference to SCA rather than requiring people to
> read
> all the specifications.
>
> I would be happy to join you in this effort. We can start using
Confluence
> Wiki to work on the documents.
>
> Does the 'user guide' sound like a good starting point for you?
>
> What do others think?
>
> Haleh
>
>
> On 2/7/07, Rick Rineholt <[EMAIL PROTECTED]> wrote:
>>
>> Hello,
>> If your totally new to SCA/Tuscany having a fresh pair of eyes looking
>> at first understanding SCA, looking at our website how easy it is to
>> find resources, how well those were, then moving on to the samples in
M2
>> and then try and understand how contribute to Tuscany itself and along
>> the way provide feedback and updates can be always beneficial. I think
>> that's ground anyone first starting out would initially have to cover
to
>> some degree or another.
>> If your not new, you'll need to give some background and where your
>> interests are in general.
>> .
>> Shelita Overton wrote:
>> > Hi I would like to help with creating some documenation for Tuscany
>> > SCA...
>> > Does anyone have any suggestions on what should be covered first?
>> > Priority?
>> > Any content that could be used as a starting point?
>> >
>> > ~Shelita Overton
>> >
>>
>>
>> ---------------------------------------------------------------------
>> 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]
