geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Aaron Mulder <>
Subject Re: Manual
Date Wed, 21 Jul 2004 13:04:53 GMT
	I guess I agree to a limited extent.  I think the wiki is great
for *developing* documentation -- FAQ's and guidance for specific topics
and so on -- but I'd like to put together a more polished document as the
main manual -- perhaps the standard routine where we make it available
electronically on the site and get it published in hardcopy as well.  To
that end, I guess I'm envisioning a little more structure and control than
the Wiki provides.  But there's certainly room for both -- it promises to
be a long effort, and a mix of FAQ's and HOWTOs and a structured manual 
and a plentiful supply of regular books would be great.


P.S. Haven't we switched Wiki's once already?  :)

On Tue, 20 Jul 2004, Dain Sundstrom wrote:
> I personally think the wiki is the best place to develop documentation, 
> because everyone can participate.  The issue is our wiki software is... 
> lets say difficult.  James Strachan has a neat utility for Confluence 
> wiki, which Codehaus uses, that converts the wiki markup to html, pdf 
> and runs all the test cases coded into the wiki.  I would like to 
> follow a similar route for our docs where we develop them on the wiki 
> and regularly stamp them and check them into the project xdocs.
> Does anyone know what we need to do to get Confluence running at Apache?
> -dain
> On Jul 20, 2004, at 2:46 PM, Aaron Mulder wrote:
> > 	I think I'm climbing out from under my rock, at least a little
> > bit, and I'd like to start work on a manual.  If I can produce a HTML
> > version, what's the best way to get it included on the 
> >
> > web site?  I'm thinking we should add a Documentation link to the left
> > navigation bar (probably under the "Geronimo" header) and then on that
> > page include a link to the HTML manual as well as to the Maven FAQ and
> > perhaps a couple Wiki links to flesh it out.
> >
> > Thanks,
> > 	Aaron

View raw message