On Sun, 2003-08-24 at 18:42, Brett Porter wrote: > Hi, > > I wanted to bounce around ideas about how we generate the site at > maven.apache.org. I fielded a question from a user on the dev list who was > trying to use installation instructions for the next release for installing > beta-10. Fair enough, since that's all that was available :) > > Here are the alternatives I can think of: > 1) distribute documentation with maven, and then express on the site that > what is there may be newer than their install - use the instructions they > got with the download > 2) create a cvs branch for each release on xdocs. Anything that applies to > current release or is news and status can be applied to the branch and the > branch is put up on the site, while release stuff is on HEAD. > 3) opposite of 2 - put new doco on a branch until the release is ready when > it can be merged to HEAD. Site is released from HEAD. > 4) Generate two sites: maven.apache.org and maven.apache.org/beta-10 - link > back to the old one from the releases page and perhaps a special case for > install instructions. > 5) opposite of 4: maven.apache.org remains as beta-10, but have a link for > "up-to-the-minute" doco. > 6) split site into two - maven-site (a new module) and then the xdoc which > is release specific. Main site can link to the latest release only for > install instructions, etc, but rest of the site stays right up to date. > > Any other ideas? I'm leaning towards (6).
The documentation on maven.apache.org should really be the doco for the released version. That's what users expect and will be least astonished. So when a release goes out the doco for the maven.apache.org site is generated with the tagged xdocs for the version. If corrections need to be made they can be and the site republished. I think work needs to be done to create links to the most recent documentation. This scenerio has been followed by the struts fellows and I think it works quite well for them. Brett, if you want to tackle this that's great. But please continue on the path your are and ask lots of questions before doing anything because this won't only affect the way we do things as every project using Maven will likely follow suit. What struts does seems reasonable, you might want to contact Ted who did a lot of the doco. I'm not sure who does it now but you might want to borrow and integrate the mechanism they use. Or we can roll something else, just take your time. > In the mean time, tomorrow when I get my first chance to do some work again, > I'll add something to the install instructions that specifies which steps > are RC1+ only. > > Do we have a specified process for getting the site released? One particular > person looking after it, or do all developers have permission to rnu maven > site:deploy? > > Cheers, > Brett > > -- > Brett Porter > Team Leader, Core Systems > f2 network ~ everything essential > -- jvz. Jason van Zyl [EMAIL PROTECTED] http://tambora.zenplex.org In short, man creates for himself a new religion of a rational and technical order to justify his work and to be justified in it. -- Jacques Ellul, The Technological Society --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
