You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by John Keyes <jo...@capeclear.com> on 2002/11/12 12:11:36 UTC
[general] Project Documentation
I think there should be two copies of a projects documentation
on the Jakarta site. One is the release copy i.e. the documentation
for the last release, the other is the actual project homepage
where the latest documentation is maintained. Do any projects
do anything like this?
Thanks,
-John K
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [general] Project Documentation
Posted by James Strachan <ja...@yahoo.co.uk>.
I guess its just a matter of extracting the website for a release to a
subdirectory.
Right now for maven-ized projects, the
maven site:deploy
creates and deploys the development website.
Maybe we could add some kind of site:release-deploy goal to publish a
specific released versions to the website, in a labelled subdirectory. This
could even be part of a standard release goal...
James
-------
http://radio.weblogs.com/0112098/
----- Original Message -----
From: "John Keyes" <jb...@mac.com>
To: "Jakarta Commons Developers List" <co...@jakarta.apache.org>
Sent: Tuesday, November 12, 2002 5:25 PM
Subject: Re: [general] Project Documentation
> I am proposing to have ONLY two versions:
>
> . the current development version
> . the last released version
>
> i.e. when a new release is ready, the previous releases
> documentation is removed and the new documentation takes
> its place.
>
> So for example:
> {1} http://j.a.org/commons/project/index.html
> {2} http://j.a.org/commons/project/development/index.html
>
> would be the only two documentation locations. {2} would
> be linked in such a way that it is obvious that it is the
> development site.
>
> The reason I mentioned this is so patches to documentation can
> be actively reviewed from j.a.org without disturbing the release
> doc.
>
> -John K
>
> On Tue, 2002-11-12 at 17:17, Henri Yandell wrote:
> > > On Tue, 2002-11-12 at 12:11, John Keyes wrote:
> > > > I think there should be two copies of a projects documentation
> > > > on the Jakarta site. One is the release copy i.e. the documentation
> > > > for the last release, the other is the actual project homepage
> > > > where the latest documentation is maintained. Do any projects
> > > > do anything like this?
> >
> > Tomcat do this. 5 versions on the current site, although they also
> > maintain multiple branches which is quite a developer overhead in my
> > opinion and not something a small commons project could handle on its
own.
> >
> > Hen
> >
> >
> > --
> > To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
> > For additional commands, e-mail:
<ma...@jakarta.apache.org>
> --
> John Keyes <jb...@mac.com>
>
>
> --
> To unsubscribe, e-mail:
<ma...@jakarta.apache.org>
> For additional commands, e-mail:
<ma...@jakarta.apache.org>
>
__________________________________________________
Do You Yahoo!?
Everything you'll ever need on one web page
from News and Sport to Email and Music Charts
http://uk.my.yahoo.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [general] Project Documentation
Posted by John Keyes <jb...@mac.com>.
I am proposing to have ONLY two versions:
. the current development version
. the last released version
i.e. when a new release is ready, the previous releases
documentation is removed and the new documentation takes
its place.
So for example:
{1} http://j.a.org/commons/project/index.html
{2} http://j.a.org/commons/project/development/index.html
would be the only two documentation locations. {2} would
be linked in such a way that it is obvious that it is the
development site.
The reason I mentioned this is so patches to documentation can
be actively reviewed from j.a.org without disturbing the release
doc.
-John K
On Tue, 2002-11-12 at 17:17, Henri Yandell wrote:
> > On Tue, 2002-11-12 at 12:11, John Keyes wrote:
> > > I think there should be two copies of a projects documentation
> > > on the Jakarta site. One is the release copy i.e. the documentation
> > > for the last release, the other is the actual project homepage
> > > where the latest documentation is maintained. Do any projects
> > > do anything like this?
>
> Tomcat do this. 5 versions on the current site, although they also
> maintain multiple branches which is quite a developer overhead in my
> opinion and not something a small commons project could handle on its own.
>
> Hen
>
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
--
John Keyes <jb...@mac.com>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [general] Project Documentation
Posted by Henri Yandell <ba...@generationjava.com>.
> On Tue, 2002-11-12 at 12:11, John Keyes wrote:
> > I think there should be two copies of a projects documentation
> > on the Jakarta site. One is the release copy i.e. the documentation
> > for the last release, the other is the actual project homepage
> > where the latest documentation is maintained. Do any projects
> > do anything like this?
Tomcat do this. 5 versions on the current site, although they also
maintain multiple branches which is quite a developer overhead in my
opinion and not something a small commons project could handle on its own.
Hen
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [general] Project Documentation
Posted by Martin van den Bemt <ml...@mvdb.net>.
I like the idea very much.. I think I saw digester or something having
javaodc online for multiple versions...
Mvgr,
Martin
On Tue, 2002-11-12 at 12:11, John Keyes wrote:
> I think there should be two copies of a projects documentation
> on the Jakarta site. One is the release copy i.e. the documentation
> for the last release, the other is the actual project homepage
> where the latest documentation is maintained. Do any projects
> do anything like this?
>
> Thanks,
> -John K
>
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [general] Project Documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On 12 Nov 2002, John Keyes wrote:
> Date: 12 Nov 2002 11:11:36 +0000
> From: John Keyes <jo...@capeclear.com>
> Reply-To: Jakarta Commons Developers List <co...@jakarta.apache.org>
> To: Jakarta Commons Developers List <co...@jakarta.apache.org>
> Subject: [general] Project Documentation
>
> I think there should be two copies of a projects documentation
> on the Jakarta site. One is the release copy i.e. the documentation
> for the last release, the other is the actual project homepage
> where the latest documentation is maintained. Do any projects
> do anything like this?
>
Struts does that -- the website is (pretty much) the current development
docco, but the menu bar has links to the docs for each release.
> Thanks,
> -John K
Craig
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>