On 10/2/06, Thilina Gunarathne <[EMAIL PROTECTED]> wrote:
+1
No go for this until we come up with a solution for the below mentioned issue:
The reason we were maintaining xdocs/1_1 dir is because we maintain multiple versions of documentation in the site. Which means that documents which are version specific needs to go under a <version name> directory in the site SVN. We use the generated docs (using maven site) of xdcos/1_1 in the axis2 site directory.
Having xdocs/1_1 means we simply do a maven site build, and copy the generated 1_1 to the axis2 site.
If we remove 1_1 from xdocs and place them all under xdocs, we will have to collect the version specifc generated docs into a 1_1 dir to be copied into the axis2 site. How is this going to be done? Doing this manually is a nightmare and highly impractical. If we want to remove 1_1 we need to find a solution for this first.
Removing 1_1 from xdocs also means that links will only work 100% either in xdocs or in svn site. As we cannot compromise site links, I guess what will be compromised is the links in xdocs.
Do we have a solution to avoid the downside of removing 1_1 from xdocs?
Thanks,
Chatra
+1 for the Deepal's idea...
So here's the plan..
Let's get rid of 1_0 directory as the first step.. Its highly unlike
that we get a change request for the 1.0 docs... In the rare case we
need to do that, we can create a separate branch of 1.0 documents as
an when needed..
+1
Then move the contents of xdocs/1_1 to xdocs/... They are anyway the
latest docs for the moment and IMO those should be the only docs
remaining in the svn head..
No go for this until we come up with a solution for the below mentioned issue:
The reason we were maintaining xdocs/1_1 dir is because we maintain multiple versions of documentation in the site. Which means that documents which are version specific needs to go under a <version name> directory in the site SVN. We use the generated docs (using maven site) of xdcos/1_1 in the axis2 site directory.
Having xdocs/1_1 means we simply do a maven site build, and copy the generated 1_1 to the axis2 site.
If we remove 1_1 from xdocs and place them all under xdocs, we will have to collect the version specifc generated docs into a 1_1 dir to be copied into the axis2 site. How is this going to be done? Doing this manually is a nightmare and highly impractical. If we want to remove 1_1 we need to find a solution for this first.
Removing 1_1 from xdocs also means that links will only work 100% either in xdocs or in svn site. As we cannot compromise site links, I guess what will be compromised is the links in xdocs.
Do we have a solution to avoid the downside of removing 1_1 from xdocs?
Thanks,
Chatra
Thanks,
~Thilina
On 9/29/06, Eran Chinthaka < [EMAIL PROTECTED]> wrote:
>
> Hmm, seems everyone is agreeing. So who opposed this earlier? :D
>
> Chatra Nakkawita wrote:
> > +1 from me too. Like you said....I agree that any changes of a previous
> > release should be made in the branch itself.
> >
> > And yes, this is not the first time we've had this arguement :-)
> >
> > Chatra
> >
> > On 9/29/06, *Afkham Azeez* < [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>>
> > wrote:
> >
> > I fully agree with Deepal. Maintaining two versions of the
> > documentation on the trunk is an adhoc way of version management.
> > When SVN does such a good job, why should we go for such an adhoc
> > structure? We never do this for the code, so why special treatment
> > for the docs? As Deepal said, the correct way of doing this should
> > be cutting a branch in SVN after the 1.1 release, and any
> > documentation bugs in 1.1 should be fixed in that branch (and most
> > probably, also in the trunk). BTW, I think this is not the first
> > time this has been argued on this list :D
> >
> > Azeez
> >
> >
> > On 9/29/06, *Deepal Jayasinghe* < [EMAIL PROTECTED]
> > <mailto:[EMAIL PROTECTED]>> wrote:
> >
> > Hi Chatra and all,
> >
> > Well , I know we had the same kind of structure for previous
> > releases as
> > well . But I am -1 on keeping two doc folders. And I can not
> > name any
> > other Apache project which use this kind of document structure.
> > In the
> > meantime keeping duplication data make unnecessary complication ,
> > - if we find error in one document , need to change them in two
> > location. Is that good habit (I dont think so)
> > - If some one new to Axis2 , and if he download Axis2 what
> > kind of doc
> > structure will he get ? if I download Axis2 today do I need to know
> > about the previous version docs. (I know its useful to have them
> > in the
> > web site , but not in the code base)
> >
> > And remember , we use "SVN" and after each release we cut a
> > branch , so if
> > some one want to update old doc , go and update them in the
> > branch (if you
> > think it is really necessary, o.w just update that in the
> > current SVN)
> >
> > Specially I dont like to have version related stuff , in the
> > current code
> > base , if we have we should remove them.
> >
> > Finally , this is the first time I -1 in this mailing list ,
> > that is b'coz
> > I honestly dont like that :).
> >
> > Thanks
> > Deepal
> >
> >
> >
> > Chatra Nakkawita wrote:
> > > Hi,
> > >
> > > Just a note to let you know that the latest dir in the
> > >
> > https://svn.apache.org/repos/asf/webservices/axis2/trunk/java/xdocs/
> > <https://svn.apache.org/repos/asf/webservices/axis2/trunk/java/xdocs/ >
> > is
> > > now renamed as 1_1.
> > >
> > > This was done as part of updating/creating documents for
> > upcoming Axis2
> > > 1.1 release and to make sure that all the links in terms of
> > Axis2 1.1
> > > documents work. The documents for this release are been worked on
> > > currently. Any document updates in terms of Axis2 1.1 version
> > needs to
> > > be made on
> > >
> > https://svn.apache.org/repos/asf/webservices/axis2/trunk/java/xdocs/1_1
> > <https://svn.apache.org/repos/asf/webservices/axis2/trunk/java/xdocs/1_1>.
> > >
> > > Once Axis2 1.1 is released, we will create a latest dir (which
> > will
> > > start off as a copy of the final 1_1 dir, to make sure that we
> > use an
> > > up-to-date documents version) which will serve as the working
> > document
> > > directory. Which means that after 1.1 release what ever
> > updates in terms
> > > of the worked on Axis2 version will be made on the new
> > 'latest' dir.
> > >
> > > Thanks & regards,
> > >
> > > Chatra
> > >
> > >
> > >
> > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > <mailto: [EMAIL PROTECTED]>
> > > For additional commands, e-mail: [EMAIL PROTECTED]
> > <mailto:[EMAIL PROTECTED]>
> >
> >
> >
> > ---------------------------------------------------------------------
> >
> > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > <mailto:[EMAIL PROTECTED]>
> > For additional commands, e-mail: [EMAIL PROTECTED]
> > <mailto:[EMAIL PROTECTED]>
> >
> >
> >
> >
> > --
> > Thanks
> > Afkham Azeez
> >
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
>
>
--
http://webservices.apache.org/~thilina/
http://thilinag.blogspot.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
