tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Aaron Bannert <aa...@ebuilt.com>
Subject Re: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatDocu mentation Redactors To Hire]
Date Sat, 07 Jul 2001 05:34:33 GMT
On Fri, Jul 06, 2001 at 10:06:21PM -0700, Craig R. McClanahan wrote:
> * Tomcat docs for a particular version should be delivered as one or more
>   web apps (not necessarily the root webapp as is current practice).  That
>   way, the corresponding WAR files could be dropped into *any* container,
>   or opened up and read directly from the filesystem.
> 
> * At least two documentation webapps (developer-oriented and
>   user-oriented) would seem to be appropriate.  Having more than two
>   will make it difficult to create reliable hyperlinks (since you don't
>   have any control over the context path that someone uses to deploy).

Although I find the rest of your comments on this topic both clear and
refreshing, I'd like to point out a possible fallacy here:

Providing Tomcat documentation in a WAR file is a little like providing
a VHS tape on how to setup your VCR. It may seem really elegant to have
on-the-fly style-generating documentation, and I may be alone on this,
but I think that the majority of the user-oriented documentation should
just be plain text. (By 'user-oriented documentation' I specifically
mean build instructions and deployment configuration docs).

Just my 2c,
-aaron


Mime
View raw message