RE: Tomcat Documentation Thoughts
Hi, But you know, I submitted a logging page doc patch over a week ago and it's still not there, and since then there have been many posts asking about this problem. I don't find that encouraging. As I responded, your patch has been committed, and it will be available in the next release. If you want something sooner or more dynamic, that's why we have a wiki. Also, there is very little documentation on how to even document! Tomcat developers make a lot of suggestions to people to go write a document then but never cite a definitive reference for how one would do that. There's a small page on how to build Tomcat but that's your lot (please correct me if I am wrong!). So that's a page I think could be helpful. There's the tech guide at http://www.apache.org/dev/contributors.html. The xdoc format is self-explanatory. Then you submit your patches in Bugzilla and we take care of building them. Let's get a page detailing a step by step how to write and contribute documentation and then let's get Tomcat's docs up to scratch by really considering the areas that come up time and again in the lists and making the Tomcat documentation deserving of its functional reputation. I've added a section to the wiki page at http://wiki.apache.org/jakarta-tomcat/HowTo. I'm glad you have the time to help, and I look forward to seeing your contributions. Happy thanksgiving ;) Yoav Shapira http://www.yoavshapira.com This e-mail, including any attachments, is a confidential business communication, and may contain information that is confidential, proprietary and/or privileged. This e-mail is intended only for the individual(s) to whom it is addressed, and may not be saved, copied, printed, disclosed or used by anyone else. If you are not the(an) intended recipient, please immediately delete this e-mail from your computer system and notify the sender. Thank you. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat Documentation Thoughts
Hey :) But you know, I submitted a logging page doc patch over a week ago and it's still not there, and since then there have been many posts asking about this problem. I don't find that encouraging. As I responded, your patch has been committed, and it will be available in the next release. If you want something sooner or more dynamic, that's why we have a wiki. Yes but the logging applies to the current release too and people are asking about it. Is the web page build quite an intensive process? I don't want to labour on the point, I just think documentation should be a priority, not a per-Tomcat-build thing. Also, there is very little documentation on how to even document! Tomcat developers make a lot of suggestions to people to go write a document then but never cite a definitive reference for how one would do that. There's a small page on how to build Tomcat but that's your lot (please correct me if I am wrong!). So that's a page I think could be helpful. There's the tech guide at http://www.apache.org/dev/contributors.html. The xdoc format is self-explanatory. Then you submit your patches in Bugzilla and we take care of building them. Well it's something but it doesn't apply to Tomcat directly. The docs are wrapped up in jakarta-catalina in webapps folder. I had to download nearly everything to find that out. he jakarta-site2 is misleading ... (this site it says). My point again is this scattering of information rather than a definitive Tomcat resource. People don't want to scout the web piecing together information on how to get a product up and going imo. I'm glad you have the time to help, and I look forward to seeing your contributions. :) ok. Happy thanksgiving ;) Yes of course, I forgot it's thanksgiving for you guys!! Enjoy :) Allistair. FONT SIZE=1 FACE=VERDANA,ARIAL COLOR=BLUE --- QAS Ltd. Developers of QuickAddress Software a href=http://www.qas.com;www.qas.com/a Registered in England: No 2582055 Registered in Australia: No 082 851 474 --- /FONT - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat Documentation Thoughts
Let's get a page detailing a step by step how to write and contribute documentation and then let's get Tomcat's docs up to scratch by really considering the areas that come up time and again in the lists and making the Tomcat documentation deserving of its functional reputation. There's the tech guide at http://www.apache.org/dev/contributors.html. The xdoc format is self-explanatory. Then you submit your patches in Bugzilla and we take care of building them. There is this also. http://jakarta.apache.org/site/jakarta-site2.html -Ben - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Tomcat Documentation Thoughts
On Wed, 24 Nov 2004 09:44:00 -0500, Shapira, Yoav [EMAIL PROTECTED] wrote: Hi, But you know, I submitted a logging page doc patch over a week ago and it's still not there, and since then there have been many posts asking about this problem. I don't find that encouraging. Is this about my problem that I posted earlier today (tomcat 5.5.4 and log4j)? About the ...[host].[/] problem? If so, could you please post your fix on this to me or this list? Regards, Wouter de Vaal - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat Documentation Thoughts
/li /ol p This log4j configuration will set up a file called tomcat.log in your Tomcat logs folder with a maximum file size of 500KB and up to 10 backups. DEBUG level is specified which will result in the most verbose output from Tomcat. The above can generate in excess of 5MB of logging with bundled web applications and Struts web applications. /p p You can of course choose to be more picky about which packages to include in the logging as with the JDK Logging. For example try substituting the last line of the above configuration with one of these: ul lilog4j.logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost]=DEBUG, R/li lilog4j.logger.org.apache.catalina.core=DEBUG, R/li lilog4j.logger.org.apache.catalina.session=DEBUG, R/li /ul /p /section section name=Conclusion p The usefulness of what you will find from internal Tomcat logging is debatable for web applications. Unless a problem with Tomcat itself exists, it is probably not required. /p p It is much more common and recommended for web application themselves to be configured with a logging setup. In the case of JDK Logging, you could setup package loggers to collect logging from your own applications, e.g codecom.mycomp.myapp.level=DEBUG/code. In the case of log4j, a custom log4j.properties file would be placed into your web application's WEB-INF/classes folder and log4j-1.2.8.jar into WEB-INF/lib and the log4j.properties file would setup a set of (normally) file appenders to collect the logging, again with package level setup, e.g codelog4j.logger.org.mycomp.myapp=DEBUG, APPENDER_TO_USE/code. /p /section -Original Message- From: Wouter De Vaal [mailto:[EMAIL PROTECTED] Sent: 24 November 2004 14:54 To: Tomcat Users List Subject: Re: Tomcat Documentation Thoughts On Wed, 24 Nov 2004 09:44:00 -0500, Shapira, Yoav [EMAIL PROTECTED] wrote: Hi, But you know, I submitted a logging page doc patch over a week ago and it's still not there, and since then there have been many posts asking about this problem. I don't find that encouraging. Is this about my problem that I posted earlier today (tomcat 5.5.4 and log4j)? About the ...[host].[/] problem? If so, could you please post your fix on this to me or this list? Regards, Wouter de Vaal - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] FONT SIZE=1 FACE=VERDANA,ARIAL COLOR=BLUE --- QAS Ltd. Developers of QuickAddress Software a href=http://www.qas.com;www.qas.com/a Registered in England: No 2582055 Registered in Australia: No 082 851 474 --- /FONT - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Tomcat Documentation Thoughts
That's useful thanks Ben :) Allistair. -Original Message- From: Ben Souther [mailto:[EMAIL PROTECTED] Sent: 24 November 2004 14:55 To: Tomcat Users List Subject: RE: Tomcat Documentation Thoughts Let's get a page detailing a step by step how to write and contribute documentation and then let's get Tomcat's docs up to scratch by really considering the areas that come up time and again in the lists and making the Tomcat documentation deserving of its functional reputation. There's the tech guide at http://www.apache.org/dev/contributors.html. The xdoc format is self-explanatory. Then you submit your patches in Bugzilla and we take care of building them. There is this also. http://jakarta.apache.org/site/jakarta-site2.html -Ben - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] FONT SIZE=1 FACE=VERDANA,ARIAL COLOR=BLUE --- QAS Ltd. Developers of QuickAddress Software a href=http://www.qas.com;www.qas.com/a Registered in England: No 2582055 Registered in Australia: No 082 851 474 --- /FONT - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
