RE: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatD ocumentation Redactors To Hire]
Assume a change to class Abc.java and a corresponding change to Abc-doc.html. Did we speak of user documentation or developper documentation ? You can change all the code you want til the user see no difference in configuration and usage. The user (and the developper of servlets/JSP) allready follow the servlet/JSP APIs... Only tomcat core and tomcat modules developpers may be impacted by code update. If the code update is important, it has been discussed on tomcat-dev and documentation update will certainly covers more than one code commit. If they are in the same CVS repository, a single commit does both. Otherwise, you need to remember to do two individual commits (one on each repository). Likewise, when you decide later to back out this change (because it was incorrect or something), you have to remember that there was also a commit on the docs repository. In the same repository, the commit message contains both sets of changes, so you know that you have to back them both out. I could agree if we're speaking of Core Developpers Documentation, but in our case, the discussion is on User Documentation. The Developper Documentation should cover architecture of Tomcat 3.2/3.3/4.0, Interceptor, Valves design and implementations and so on. Do you plan to make a real-time core developper documentation following all the code change ? There is allready TC-DEV, javadoc and cvs for tracking all that changes.
RE: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatD ocumentation Redactors To Hire]
Title: RE: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatD ocumentation Redactors To Hire] I like docbook. -Original Message- From: GOMEZ Henri [SMTP:[EMAIL PROTECTED]] Sent: Tuesday, July 03, 2001 1:06 AM To: [EMAIL PROTECTED] Subject: RE: [PRE-PROPOSAL] jakarta-tomcat-doc sub-project : WAS: [TomcatD ocumentation Redactors To Hire] Ok, ok. Many debate here about using anakia, stylebook, docbook or xxxbook. There is a tool today, that's let you documentation in a standard format we could use, abiword (http://www.abisource.com/). It's free, have a decent GUI, is available for Windows, Unix, GNOME, BeOS and QNX, and even MacOS X (for Pier purpose). It let you export document in DocBook format WHICH is a standard. Apache used to follow standard, docbook is a standard, an Open Standard, so why not use this one ? If we have remark or comments, or detect lack, we still could be involved - Henri Gomez ___[_] EMAIL : [EMAIL PROTECTED] (. .) PGP KEY : 697ECEDD ...oOOo..(_)..oOOo... PGP Fingerprint : 9DF8 1EA8 ED53 2F39 DC9B 904A 364F 80E6
