tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject Re: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatDocu mentation Redactors To Hire]
Date Sat, 07 Jul 2001 07:23:36 GMT
On Fri, Jul 06, 2001 at 10:06:21PM -0700, Craig R. McClanahan wrote:
> * Docs should live in the source tree of the project that they
>   are about.  Although Henri's suggestion for jakarta-tomcat-docs
>   is noble, what you'll find in practice is that there is very little
>   documentation that is relevant across multiple versions of Tomcat.

That remains to be seen.  My gut tells me the opposite.  I'm thinking
connectors, classpath issues (though some details are different with
Catalina, a lot are the same), web.xml docs, authentication,
performance-tuning a web app... I'd love to get your input on the
outline I just posted if you get around to it -- tell me which
sections are definitely different between 3 and 4.

The current situation with the docs on the site for 3.2 and 3.3
illustrate the problem with fragmenting two doc trees that are
actually very similar.  Any reorganization or new docs or error fixing
will need to be propagated back to the 3.2 branch, which will be a
terror to maintain.  I feel the same thing could easily happen with
4.0 vs 4.1 in the near future.

> * The files that are checked in should only be the XML sources, *not* the
>   generated files.  This varies from what Jon set up in jakarta-site2,
>   based on long and drawn out earlier discussions (same issues as those
>   surrounding checking JAR files into CVS :-).


.xml = .java, .html = .class
./ docs would generate the html directory

Alex Chaffee             
jGuru - Java News and FAQs
Creator of Gamelan       
Founder of Purple Technology
Curator of Stinky Art Collective

View raw message