tried to comment on the page but it threw an error... here's my comment
Agree that current situation is sub-optimal. Ideally, IMHO, documentation ought to be able to be generated easily within each module and previewed by the module maintainer. If this step doesnt require a build, but a build actually checked for the presence of the expected documentation that would help IMHO. This would also allow us to compare dates of documentation and changes, and automatically include a per-module list of changes per release tag. The master documentation should then automatically include each module's doc, making the whole thing more regulary structured and updated. I also had a quick look to see how to include a comment submission form on the page but it wasnt obvious. Rob A On Wed, Sep 3, 2008 at 8:21 AM, Mike Pumphrey <[EMAIL PROTECTED]> wrote: > I think the community docs would necessarily be in a wiki format. As > for the official canon, I don't think that adding version > control/management would be a bad thing. > > The other thing to mention is that one-off docs (GSIPs, etc) would > necessarily not be part of this framework, just the basic docs that > presumably wouldn't be so variable. > > That said, if you have other suggestions on tools, I'm happy to hear of > them. I really like Sphinx, personally, and its PDF output is > magnificent. :) > > Thanks, > Mike > > Andrea Aime wrote: >> Mike Pumphrey ha scritto: >>> Hi there. I've written up a GSIP (my first!) and would like >>> everyone's feedback on it. >>> >>> http://geoserver.org/display/GEOS/GSIP+25+-+New+Documentation+Framework >> >> Mumble is it just me, or only DocuWiki can be edited online? >> The other two would have to be stored in svn, right? >> The parallel structure is ok for me, I'd say, at least the >> community contributed docs should be in a wiki. >> >> Choice wise, I would like to avoid anything that requires >> a build to see the resulting page, and in particular docbook, tried >> it out manually and also with a java based helper editor >> (free for docbook), was a pain in both cases. >> >> Cheers >> Andrea > > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Geoserver-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/geoserver-devel > ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Geoserver-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geoserver-devel
