You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@tomcat.apache.org by GOMEZ Henri <hg...@slib.fr> on 2001/06/29 09:41:52 UTC
[Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
> Not to get into a great big argument over OS version commercial
>products, but if OS projects expect to be taken with the same
>consideration
>as commercial they have to accept to be compared across the board. This
>includes documentation. You can't just pick and choose the
>battles you want
>to fight.
Could we close this thread positively ?
We all know that tomcat documentation is incomplete and we need help
in that area.
Tomcat IS AN OPENSOURCE project with a big user community,
Jon Stevens recently reported more than 50-100k downloads / month.
Everybody could be involved in the project, and not necessary
developpers. I'm sure there is around potentials documentation
redactors.
So who will be interested in working on the Tomcat Documentation ?
------------------------------------------------------------------
>For the most part, the documentation in OS projects
>just plain
>sucks, if it even exists. Believe it or not this is one of the
>reasons OS is
>often frowned upon. Look at Microsoft, sure its close source,
>people may
>think it sucks, blah blah blah, but do you have idea how much
>information is
>on MSDN?
> The lack of documentation available goes against some very basic
>rules of Software Engineering. In the real world does this
>really matter? I
>dunno, but often times packaging and presentation, and a
>finished looka nd
>feel are the key to getting in the door and this is where most
>OS projects
>fail miserably.
> Because its free might be the reason the documentation sucks, it
>shouldn't be a justification. (not that i'm saying tomcat sucks, just
>argueing the point).
>
Re: [Tomcat Documentation Redactors]
Posted by Simon Brooke <si...@beesianum.jasmine.org.uk>.
On Friday 29 June 2001 15:34, Milt Epstein wrote:
> On Fri, 29 Jun 2001, Simon Brooke wrote:
> > Two ways we could go - the 'Tutorial' or 'User Manual' route which
> > might go something like
> >
> > Introduction
> > Overview
> > Downloading and Installing
> > Configuring
> > Integration with Apache
> > Integration with IIS
> > Deploying Webapps
> > Advanced Administration
> > Load balancing
> > Performance tuning
> > Hacker's Guide
>
> As has been said, there is the "tomcat book" effort at sourceforge,
> and it would be silly to take on a parallel effort to that. The URL
> for that is either
>
> http://tomcatbook.sourceforge.net
>
> or
>
> http://sourceforge.net/projects/tomcatbook/
>
> I think the working TOC there is very similar to what you have above.
> There may not currently be all that much stuff there yet --
OK, to get hold of what is:
CVSROOT=:pserver:anonymous@cvs.tomcatbook.sourceforge.net:2401/cvsroot/tomcatbook
cvs login
cvs checkout tcguide
As far as I can see there are only two chapters currently in the CVS,
namely
gododdin:~/tmp/tcguide$ find . -name *.xml
./AdvConfig/advconfig.xml
./iPlanet/iplanet.xml
They are marked up in DocBook and at superficial reading seem well
structured and well written.
--
simon@jasmine.org.uk (Simon Brooke) http://www.jasmine.org.uk/~simon/
-- mens vacua in medio vacuo --
Re: [Tomcat Documentation Redactors]
Posted by Frans Thamura <ft...@yahoo.com>.
That project is not work well??? I cannot download the pdf or html file
Frans
----- Original Message -----
From: "Milt Epstein" <me...@uiuc.edu>
To: <to...@jakarta.apache.org>
Sent: Friday, June 29, 2001 9:34 PM
Subject: Re: [Tomcat Documentation Redactors]
> On Fri, 29 Jun 2001, Simon Brooke wrote:
>
> > On Friday 29 June 2001 08:41, you wrote:
> > > > Not to get into a great big argument over OS version commercial
> > > >products, but if OS projects expect to be taken with the same
> > > >consideration
> > > >as commercial they have to accept to be compared across the board.
> > > > This includes documentation. You can't just pick and choose the
> > > >battles you want
> > > >to fight.
> > >
> > > Could we close this thread positively ?
> > >
> > > We all know that tomcat documentation is incomplete and we need help
> > > in that area.
> >
> > This is a good idea. I don't know how much I would be able to
> > contribute, because there must be plenty of people with more expertise
> > than I have. However, If someone could draft a 'contents', then
> > probably different people could pick different aspects and write about
> > them, in which case I could probably contribute something useful about
> > installing and configuring webapps.
> >
> > Two ways we could go - the 'Tutorial' or 'User Manual' route which
> > might go something like
> >
> > Introduction
> > Overview
> > Downloading and Installing
> > Configuring
> > Integration with Apache
> > Integration with IIS
> > Deploying Webapps
> > Advanced Administration
> > Load balancing
> > Performance tuning
> > Hacker's Guide
> [ ... ]
>
> As has been said, there is the "tomcat book" effort at sourceforge,
> and it would be silly to take on a parallel effort to that. The URL
> for that is either
>
> http://tomcatbook.sourceforge.net
>
> or
>
> http://sourceforge.net/projects/tomcatbook/
>
> I think the working TOC there is very similar to what you have above.
> There may not currently be all that much stuff there yet -- the effort
> started a few months ago, and there was a lot of activity and
> interest, but that level of activity hasn't continued (probably
> because it takes a lot of work and people are busy). But progress is
> being made, and will continue. So if people want to help out it might
> be good to join up over there and contribute instead of starting
> something new/separate. There is also a mailing list on yahoogroups
> called tcbook that people can subscribe to (it's pretty low volume
> currently).
>
> Milt Epstein
> Research Programmer
> Software/Systems Development Group
> Computing and Communications Services Office (CCSO)
> University of Illinois at Urbana-Champaign (UIUC)
> mepstein@uiuc.edu
_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com
Re: [Tomcat Documentation Redactors]
Posted by Milt Epstein <me...@uiuc.edu>.
On Fri, 29 Jun 2001, Simon Brooke wrote:
> On Friday 29 June 2001 08:41, you wrote:
> > > Not to get into a great big argument over OS version commercial
> > >products, but if OS projects expect to be taken with the same
> > >consideration
> > >as commercial they have to accept to be compared across the board.
> > > This includes documentation. You can't just pick and choose the
> > >battles you want
> > >to fight.
> >
> > Could we close this thread positively ?
> >
> > We all know that tomcat documentation is incomplete and we need help
> > in that area.
>
> This is a good idea. I don't know how much I would be able to
> contribute, because there must be plenty of people with more expertise
> than I have. However, If someone could draft a 'contents', then
> probably different people could pick different aspects and write about
> them, in which case I could probably contribute something useful about
> installing and configuring webapps.
>
> Two ways we could go - the 'Tutorial' or 'User Manual' route which
> might go something like
>
> Introduction
> Overview
> Downloading and Installing
> Configuring
> Integration with Apache
> Integration with IIS
> Deploying Webapps
> Advanced Administration
> Load balancing
> Performance tuning
> Hacker's Guide
[ ... ]
As has been said, there is the "tomcat book" effort at sourceforge,
and it would be silly to take on a parallel effort to that. The URL
for that is either
http://tomcatbook.sourceforge.net
or
http://sourceforge.net/projects/tomcatbook/
I think the working TOC there is very similar to what you have above.
There may not currently be all that much stuff there yet -- the effort
started a few months ago, and there was a lot of activity and
interest, but that level of activity hasn't continued (probably
because it takes a lot of work and people are busy). But progress is
being made, and will continue. So if people want to help out it might
be good to join up over there and contribute instead of starting
something new/separate. There is also a mailing list on yahoogroups
called tcbook that people can subscribe to (it's pretty low volume
currently).
Milt Epstein
Research Programmer
Software/Systems Development Group
Computing and Communications Services Office (CCSO)
University of Illinois at Urbana-Champaign (UIUC)
mepstein@uiuc.edu
Re: [Tomcat Documentation Redactors]
Posted by Simon Brooke <si...@beesianum.jasmine.org.uk>.
On Friday 29 June 2001 08:41, you wrote:
> > Not to get into a great big argument over OS version commercial
> >products, but if OS projects expect to be taken with the same
> >consideration
> >as commercial they have to accept to be compared across the board.
> > This includes documentation. You can't just pick and choose the
> >battles you want
> >to fight.
>
> Could we close this thread positively ?
>
> We all know that tomcat documentation is incomplete and we need help
> in that area.
This is a good idea. I don't know how much I would be able to
contribute, because there must be plenty of people with more expertise
than I have. However, If someone could draft a 'contents', then
probably different people could pick different aspects and write about
them, in which case I could probably contribute something useful about
installing and configuring webapps.
Two ways we could go - the 'Tutorial' or 'User Manual' route which
might go something like
Introduction
Overview
Downloading and Installing
Configuring
Integration with Apache
Integration with IIS
Deploying Webapps
Advanced Administration
Load balancing
Performance tuning
Hacker's Guide
Or else we could as a set of HOWTOs. On the whole I prefer the HOWTO
approach because
It needs less central co-ordination and administration
It needs less editing - one doesn't need so much consistency
of style
It's easier to find the specific bit of documentation you need
It's task and solution oriented.
--
simon@jasmine.org.uk (Simon Brooke) http://www.jasmine.org.uk/~simon/
-- mens vacua in medio vacuo --
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Julien Gilli <da...@bigfoot.com>.
> So who will be interested in working on the Tomcat Documentation ?
I am highly interested. I am writing a french tutorial about servlets (which
can be found at http://darktigrou.free.fr/). It's a work in progress.
I am also involved in the french python translation group
(http://frpython.sourceforge.net/) and i love docs :-).
So please let me know if this idea get into a real project.
Regards,
Julien Gilli.
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Frans Thamura <ft...@yahoo.com>.
I think a commiter must create a draft article, explain tomcat, and there
will be a team, that will review, and ask that article, and may be several
of those articles have a comment.. see php manual in php.net
The team update the article, and after that. this like CVS for
documentation, and the documentation is focus in English first, and follow
with any other language.
Frans
----- Original Message -----
From: "Tim Stoop" <t....@ehrmweb.nl>
To: <to...@jakarta.apache.org>
Sent: Friday, June 29, 2001 3:26 PM
Subject: Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
> Carlos Ferreira wrote:
> >
> > i could help with translations: french, german, portuguese
>
> And I with the Dutch version. I'd also be willing to write, but I'm
> quite new with Tomcat and since I started with JServ a year and a half
> ago, Tomcat isn't very transparant for me, I'm afraid...
_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Tim Stoop <t....@ehrmweb.nl>.
Carlos Ferreira wrote:
>
> i could help with translations: french, german, portuguese
And I with the Dutch version. I'd also be willing to write, but I'm
quite new with Tomcat and since I started with JServ a year and a half
ago, Tomcat isn't very transparant for me, I'm afraid...
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Roland Carlsson <ro...@swetravel.se>.
I can offer Swedish translation from the english texts. Please take contact on rolca@telia.com (private adress). Could be a nice way getting involved.
Regards
Roland Carlsson
----- Original Message -----
From: "Carlos Ferreira" <ca...@gilem.com>
To: <to...@jakarta.apache.org>
Sent: Friday, June 29, 2001 10:10 AM
Subject: Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
> i could help with translations: french, german, portuguese
>
>
> ----- Original Message -----
> From: "GOMEZ Henri" <hg...@slib.fr>
> To: <to...@jakarta.apache.org>
> Cc: <to...@jakarta.apache.org>
> Sent: Friday, June 29, 2001 9:41 AM
> Subject: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
>
>
> > > Not to get into a great big argument over OS version commercial
> > >products, but if OS projects expect to be taken with the same
> > >consideration
> > >as commercial they have to accept to be compared across the board. This
> > >includes documentation. You can't just pick and choose the
> > >battles you want
> > >to fight.
> >
> > Could we close this thread positively ?
> >
> > We all know that tomcat documentation is incomplete and we need help
> > in that area.
> >
> > Tomcat IS AN OPENSOURCE project with a big user community,
> > Jon Stevens recently reported more than 50-100k downloads / month.
> >
> > Everybody could be involved in the project, and not necessary
> > developpers. I'm sure there is around potentials documentation
> > redactors.
> >
> > So who will be interested in working on the Tomcat Documentation ?
> >
> > ------------------------------------------------------------------
> >
> >
> > >For the most part, the documentation in OS projects
> > >just plain
> > >sucks, if it even exists. Believe it or not this is one of the
> > >reasons OS is
> > >often frowned upon. Look at Microsoft, sure its close source,
> > >people may
> > >think it sucks, blah blah blah, but do you have idea how much
> > >information is
> > >on MSDN?
> > > The lack of documentation available goes against some very basic
> > >rules of Software Engineering. In the real world does this
> > >really matter? I
> > >dunno, but often times packaging and presentation, and a
> > >finished looka nd
> > >feel are the key to getting in the door and this is where most
> > >OS projects
> > >fail miserably.
> > > Because its free might be the reason the documentation sucks, it
> > >shouldn't be a justification. (not that i'm saying tomcat sucks, just
> > >argueing the point).
> > >
>
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Carlos Ferreira <ca...@gilem.com>.
i could help with translations: french, german, portuguese
----- Original Message -----
From: "GOMEZ Henri" <hg...@slib.fr>
To: <to...@jakarta.apache.org>
Cc: <to...@jakarta.apache.org>
Sent: Friday, June 29, 2001 9:41 AM
Subject: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
> > Not to get into a great big argument over OS version commercial
> >products, but if OS projects expect to be taken with the same
> >consideration
> >as commercial they have to accept to be compared across the board. This
> >includes documentation. You can't just pick and choose the
> >battles you want
> >to fight.
>
> Could we close this thread positively ?
>
> We all know that tomcat documentation is incomplete and we need help
> in that area.
>
> Tomcat IS AN OPENSOURCE project with a big user community,
> Jon Stevens recently reported more than 50-100k downloads / month.
>
> Everybody could be involved in the project, and not necessary
> developpers. I'm sure there is around potentials documentation
> redactors.
>
> So who will be interested in working on the Tomcat Documentation ?
>
> ------------------------------------------------------------------
>
>
> >For the most part, the documentation in OS projects
> >just plain
> >sucks, if it even exists. Believe it or not this is one of the
> >reasons OS is
> >often frowned upon. Look at Microsoft, sure its close source,
> >people may
> >think it sucks, blah blah blah, but do you have idea how much
> >information is
> >on MSDN?
> > The lack of documentation available goes against some very basic
> >rules of Software Engineering. In the real world does this
> >really matter? I
> >dunno, but often times packaging and presentation, and a
> >finished looka nd
> >feel are the key to getting in the door and this is where most
> >OS projects
> >fail miserably.
> > Because its free might be the reason the documentation sucks, it
> >shouldn't be a justification. (not that i'm saying tomcat sucks, just
> >argueing the point).
> >
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Thomas Colin de Verdiere <td...@scort.com>.
Well,
i'd like to document JNIEndpoint, JNIEndpointConnector, jni in process
(for IIS)
Justin Erenkrantz wrote:
>
> On Fri, Jun 29, 2001 at 09:41:52AM +0200, GOMEZ Henri wrote:
> > So who will be interested in working on the Tomcat Documentation ?
>
> I'd be willing to proofread and validate any docs for the j-t-c (i.e.
> Apache/Tomcat integration). I don't have time to actually write the
> docs, but I could conceivably help those who don't understand how it
> works, but do have the time and patience to learn it and write docs
> for it.
>
> Anyone who is interested, just drop me a line.
>
> Writing end-user documentation is a good way of finding holes in a
> design that may not be obvious from the code itself. -- justin
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Justin Erenkrantz <je...@ebuilt.com>.
On Fri, Jun 29, 2001 at 09:41:52AM +0200, GOMEZ Henri wrote:
> So who will be interested in working on the Tomcat Documentation ?
I'd be willing to proofread and validate any docs for the j-t-c (i.e.
Apache/Tomcat integration). I don't have time to actually write the
docs, but I could conceivably help those who don't understand how it
works, but do have the time and patience to learn it and write docs
for it.
Anyone who is interested, just drop me a line.
Writing end-user documentation is a good way of finding holes in a
design that may not be obvious from the code itself. -- justin
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Justin Erenkrantz <je...@ebuilt.com>.
On Fri, Jun 29, 2001 at 09:41:52AM +0200, GOMEZ Henri wrote:
> So who will be interested in working on the Tomcat Documentation ?
I'd be willing to proofread and validate any docs for the j-t-c (i.e.
Apache/Tomcat integration). I don't have time to actually write the
docs, but I could conceivably help those who don't understand how it
works, but do have the time and patience to learn it and write docs
for it.
Anyone who is interested, just drop me a line.
Writing end-user documentation is a good way of finding holes in a
design that may not be obvious from the code itself. -- justin
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Alex Fernández <af...@tid.es>.
Hi Henri!
One suggestion: create a mailing list (e.g. tomcat-doc) so that folks
may speak about docs. Also, it would show some level of commitment -- at
least you have to subscribe.
Un saludo,
Alex.
GOMEZ Henri wrote:
>
> > Not to get into a great big argument over OS version commercial
> >products, but if OS projects expect to be taken with the same
> >consideration
> >as commercial they have to accept to be compared across the board. This
> >includes documentation. You can't just pick and choose the
> >battles you want
> >to fight.
>
> Could we close this thread positively ?
>
> We all know that tomcat documentation is incomplete and we need help
> in that area.
>
> Tomcat IS AN OPENSOURCE project with a big user community,
> Jon Stevens recently reported more than 50-100k downloads / month.
>
> Everybody could be involved in the project, and not necessary
> developpers. I'm sure there is around potentials documentation
> redactors.
>
> So who will be interested in working on the Tomcat Documentation ?
>
> ------------------------------------------------------------------
>
> >For the most part, the documentation in OS projects
> >just plain
> >sucks, if it even exists. Believe it or not this is one of the
> >reasons OS is
> >often frowned upon. Look at Microsoft, sure its close source,
> >people may
> >think it sucks, blah blah blah, but do you have idea how much
> >information is
> >on MSDN?
> > The lack of documentation available goes against some very basic
> >rules of Software Engineering. In the real world does this
> >really matter? I
> >dunno, but often times packaging and presentation, and a
> >finished looka nd
> >feel are the key to getting in the door and this is where most
> >OS projects
> >fail miserably.
> > Because its free might be the reason the documentation sucks, it
> >shouldn't be a justification. (not that i'm saying tomcat sucks, just
> >argueing the point).
> >
Re: [Tomcat Documentation Redactors To Hire] - WAS: TOMCAT SUCKS
Posted by Bo Xu <bo...@cybershop.ca>.
GOMEZ Henri wrote:
> [...]
> We all know that tomcat documentation is incomplete and we need help
> in that area.
>
> Tomcat IS AN OPENSOURCE project with a big user community,
> Jon Stevens recently reported more than 50-100k downloads / month.
>
> Everybody could be involved in the project, and not necessary
> developpers. I'm sure there is around potentials documentation
> redactors.
>
> So who will be interested in working on the Tomcat Documentation ?
> [...]
Hi :-) if it is possible, I want to work for Tomcat Documentation :-)
Bo
June 29, 2001