RE: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatDocu mentation Redactors To Hire]

[Rob S.]

> 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).

It would be in a WAR file as HTML.  The build would do the transformation
and create the WAR file.

Two things:

1) Users may be confused as to "where the docs went" if they don't see a
/docs directory.  Solution (one of many): have /docs/readme.txt with a
pointer back to /INSTALL.txt.  A quick-install guide would be pretty
short...

2) Why have the docs as a web app?  I'm not sure I see the benefits yet,
aside from being able to have a pointer to the docs from the ROOT/index
page.

- r