Alex, That's a really good start. My only comment right now is to point out that some of the topics in this list are Jakarta specific and Apache is much bigger than Jakarta. It would be cool if a manual such as this covered how other Apache projects handle similar tasks.
I'd also include a chapter on Apache and Jakarta rules. For example, voting rules, what constitutes a valid vote, what are the voting types and when they apply, what are meanings of +1/+0/0/-0/-1 in the various voting types. A collection of release instructions for various projects might also be useful. When I was the release manager for Tomcat 3.2.x I got some initial help from Craig, but after that I had to invent most of the process myself (and I'll be the first admit that I didn't document that process :-( ). I'm sure I think of more after giving it some more thought. Good start, though. Marc Saegesser > -----Original Message----- > From: Fernandez Martinez, Alejandro > [mailto:[EMAIL PROTECTED]] > Sent: Wednesday, February 20, 2002 12:04 PM > To: 'Jakarta General List' > Subject: RE: Apache Manual (was ApacheForge) > > > Why not start it yourself and anyone can suggest changes. > > On the other hand, why not start it myself. Something like this: > > 1.- Introduction > Who we are, why are we doing this. > > 2.- Project proposal > Proposal stage, committers needed, community. > > 3.- Code organization and repositories > Naming of packages, repositories, what to find in them. > Who touches what. > > 4.- Code quality > Add copyright notice, add authors. > Format your code but not others'. > > 4.- Build system > Use Ant, use Ant, use Ant. > Use Gump. > Use Scarab. > > 5.- Dependencies > What jar's to use and what to avoid. > > 6.- Documentation > Where to look for it. > What to expect, what not to expect. > > 7.- Support > Whom you should ask, what you should figure out yourself. > > 8.- Licensing and guarantee > Why you should use Apache license, and what's wrong with > other licenses. > What you can do with Apache products. Giving credit. > All that implied warranty things. > > Un saludo, > > Alex. > > > -----Mensaje original----- > > De: Paul Hammant [mailto:[EMAIL PROTECTED]] > > Enviado el: miércoles 20 de febrero de 2002 18:51 > > Para: Jakarta General List > > Asunto: Apache Manual (was ApacheForge) > > > > > > Jon, > > > > Give us a TOC for what you think might be a good starting point. > > > > >That said, I will do my best to support someone who wants to > > create a manual > > >like that. If you hang around here and watch what happens > > and how people do > > >things and start to document it. Then I promise to review it > > and comment on > > >it. > > > > > - Paul > > > > > > > > -- > > To unsubscribe, e-mail: > > <mailto:[EMAIL PROTECTED]> > > For additional commands, e-mail: > > <mailto:[EMAIL PROTECTED]> > > > -- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
