This brings up a question that I've never really figured out how to do nicely:
Naturally when you read a reference manual, you want it to reflect the version of the software you're using. I'm not aware of a way to do this when the documentation is inside of Confluence. Can this be done? Is there a way to export the Reference Manual pages into, say, .html, single-page .html and .pdf right before we cut a release? This way, previous versions could be archived online, but the current Confluence pages always reflect the current version? Or, is it better to try to move this stuff in to Docbook XML so it is versioned with the source code directly? I have to say that I like using wiki markup _much_ better than XML, but I don't want discrepancies between docs and code versions. What is the best way to accomplish this? Spring and Hibernate have what I consider best-of-breed documentation, but they are Docbook based. Then again, Grails documentation is pretty nice, and I believe they use Confluence to manage their docs. Does anyone know how the Grails team does this? Any suggestions? Thanks, Les On Thu, Jan 14, 2010 at 6:34 PM, Kalle Korhonen <[email protected]> wrote: > And on that note, let's call the release 1.0.0. I know the snapshot's > still using 1.0-SNAPSHOT but we can set the release version at release > time, then prepare the trunk for development of 1.0.1-SNAPSHOT. > > Kalle > > > On Thu, Jan 14, 2010 at 3:20 PM, Les Hazlewood <[email protected]> wrote: >> For those who don't know, I've started on a Reference Manual to >> accompany the 1.0 release. It is still being flushed out, but at >> least its a start: >> >> http://cwiki.apache.org/confluence/display/SHIRO/Reference >> >> Please feel free to comment - suggestions welcome! >> >> Best, >> >> Les >> >
