The Struts site originally had the latest and greatest reflected on the main
page, but this caused a lot of confusion, and innumerable postings to
struts-user. To fix this, we (i.e. Ted :) changed the main page to reflect
the currently released version, but included links to the latest and
greatest at the bottom of the page menu, so that documentation is available
for both versions.

Behind the scenes in CVS-land, we cloned the docs into a 'legacy' directory
when we branched the project, so that we could make changes to both
independently but also make both available on the Struts web site.

--
Martin Cooper


----- Original Message -----
From: "Vincent Massol" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, January 16, 2002 3:34 PM
Subject: Managing project documentation (release vs CVS versions) ?


> Hi,
>
> I have always been pondering how to best manage the following. Should
> there be 2 web sites per project : one for the latest release
> (containing docs + javadoc corresponding to the latest release) and one
> for nightly builds (containing docs + javadocs corresponding to the
> latest code) ?
>
> When I work on a new feature that I want to document, I cannot document
> it in the xdocs/ directory because next time I change something for the
> web site and I want to make that change visible, it will also contain
> the new feature documentation. However, that feature is only present in
> CVS (not released yet) and users will have trouble understanding why
> this feature does not work with the code they downloaded. Of course, I
> could have a header that says "WARNING: Feature only available in CVS"
> but it is awkward. Another solution is to have 2 xdocs directory but
> again this is awkward ...
>
> Any idea ? How are other projects doing this ?
>
> Thanks
> -Vincent
>
> _______________________
> Vincent Massol
> OCTO Technology UK Ltd
> www.octo.com
> [EMAIL PROTECTED]
> Tel: (020) 8996 9540
>
>
>
>
> --
> To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
>


--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to