Hi all, first an important note: Pivot Site in an Apache Web Site, so it's built using Tools available, and for example when it was built (years ago) we had to use an xml representation of pages (Anakia if I remember well), and generate html pages using xslt trasfromations (triggered by Ant). Anyway we should migrate to the new Apache CMS (this is an ASF-wide task already started in many projects), but this probably need a complete rework of our site (and I'm not sure on the level of customization for the Graphics, but this is a detail) ... could be a mid/long term work, but it's a lot of work. Just for reference, sources (and a copy of the real site) are here: http://svn.apache.org/repos/asf/pivot/site/trunk/
Roger, could you verify with Infra if we can have a staging web site to start migrate ? > 1. First thing. Don't worry about anything beyond step 1. - which is to > compile as thorough a compendium of documentation as you can for the current > versions. ok > 2. Keeping it in sync and up to date is a worry that is great for providing > obstacles daunting enough to keep one from not doing anything to begin with. yes, I know that this is a problem, because usually source snippets for web pages aren't updated ... but here we need a way to link related sources in svn, or include them when generating the site. > 3. Once a thorough doc representation is compiled, organized and available - > the next step is maybe marking sections with a legend to show which are > affected by > current changes. This can eventually be automated - such that when the > documentation is generated from some base, it can automatically update > symbols shown > in the document which represent or explicitly show markers pointing to > current builds/versions/bug-fixes etc. this would be great, but we need some tool (and rework all the doc section of the project) ... so suggestions (and help here :-) ) are welcome ... > 4. Next, you could provide a way to have the author of fixes link their > documentation changes to a check in, then when builds are executed, the > documentation can be > automatically updated - relevant to that section. using the CMS probably this would be easier ... Note that we have a Wiki (only few pages inside) where registered users can do updates (and add pages I think) ... this could be a simple way to write post/updates in the short term. > But I would take baby steps. Step one is definitely needed and would be very > widely appreciated. ok, David thanks for the feedback for now. Bye, Sandro
