On 1/16/02 6:34 PM, "Vincent Massol" <[EMAIL PROTECTED]> wrote:

> 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 ?


In velocity-land, we document to the latest-greatest.  I guess it would be
good to note that on the site :)

Then, when a release is made, the docs reflect the state of the project at
the time the branch is made for the release.

Keeps things simple, and we really haven't had a problem yet.  However, this
is a good point, and I'll look into noting that somewhere.

-- 
Geir Magnusson Jr.                                     [EMAIL PROTECTED]
System and Software Consulting
"They that can give up essential liberty to obtain a little temporary safety
deserve neither liberty nor safety." - Benjamin Franklin



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

Reply via email to