+1 on versioning SCA docs

Assuming two versions of SCA Java, I can see that the following page will
change to point to two different versions of SCA Java, 1.x and 2.x and their
related documentation.

http://incubator.apache.org/tuscany/tuscany-downloads-documentations.html

Tuscany SCA Java general page would contain general information that would
pertain to both versions. So, it might need to change.
http://incubator.apache.org/tuscany/sca-java.html

On the left navigation of sca-java page, we would have two boxes
SCA Java 2.x
SCA Java 1.x

each would point to their own releases and their own documentations and
source code tree.

There is a set of documentations under SCA Java that are generic, like
development guide. We could share these pages between the two versions.

Does this make sense?

On 4/9/08, Simon Laws <[EMAIL PROTECTED]> wrote:
>
> On Tue, Apr 8, 2008 at 6:57 PM, Dan Becker <[EMAIL PROTECTED]> wrote:
>
> > ant elder wrote:
> >
> > > On Tue, Apr 8, 2008 at 6:11 PM, Simon Laws <[EMAIL PROTECTED]>
> > > wrote:
> > >
> > > We may need to branch the documentation also. Normally I would suggest
> > > that
> > >
> > > > we ask for a new space but as our documentation could not be
> > > > considered
> > > > complete for 1.1 and as the suggested first actions are internal
> > > > restructuring we may find it less onerous to maintain 2.X documents
> > > > alongside the the 1.X documents with suitable comments to point out
> > > > where
> > > > they diverge. Do people have a preference.
> > > >
> > > >
> > > >  I wondered about the doc too, if there was a new wiki space for 2.x
> > > could it
> > > be initially be populated with the existing content? If so then it
> seems
> > > to
> > > me like it would be easiest to have the new space than to try point
> out
> > > the
> > > differences for each release all in the one space.
> > >
> >
> >
> > +1 on versioning and branching the docs and the wikis. Customers on
> older
> > levels will want to see the proper docs, configs, and samples for their
> > version, and customers on newer levels will want to see proper docs,
> > configs, and samples for their version. We should support them both.
> >
> > (This is also how the Geronimo team is tacking docs and samples.)
> >
> > --
> > Thanks, Dan Becker
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > For additional commands, e-mail: [EMAIL PROTECTED]
> >
> >
>
> If the concensus is for a completely separate space then it would seem
> that
> we need a new space to hold just Java SCA V2 docs (The current site space
> holds all the pages for all of the Tuscany projects).  Maybe we want to
> reorganize along the same lines as Geronimo e.g. multiple spaces such as
>
> Apache Tuscany - our current site wiki
> Apache Tuscany SCA Java V1
> Apache Tuscany SCA Java V2
>
> I still slightly favour creating a "V2 Documentation" page on the existing
> wiki and populate it as and when required for the time being though.
>
> Simon
>

Reply via email to