Ok, thanks a lot, Marc and Jon.

Included are some links from xml.apache.org, luckily they resemble Jakarta's
documents a lot. I know nothing about other Apache projects; I started
adding links from httpd.apache.org like crazy, but then realized that the
TOC was losing focus exponentially. Probably, someone else should tackle
this problem.

Now, including the valuable contributions of Marc and Jon, the annotated
Apache manual TOC would look like this.

1.- Introduction
  Who we are, why are we doing this.

  http://jakarta.apache.org/site/whoweare.html
  http://xml.apache.org/whoweare.html
  http://httpd.apache.org/ABOUT_APACHE.html

2.- Project proposal
  Proposal stage, committers needed, community.

  http://jakarta.apache.org/site/getinvolved.html
  http://jakarta.apache.org/site/newproject.html

3.- Apache rules
  Who gets to vote what.
  Voting rules, valid votes, +1/+0/0/-0/-1.

  http://jakarta.apache.org/site/roles.html
  http://jakarta.apache.org/site/decisions.html
  http://xml.apache.org/roles.html
  http://xml.apache.org/decisions.html
  http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt
  
4.- Code organization and repositories
  Naming of packages, repositories, what to find in them.
  Who touches what.

  http://jakarta.apache.org/site/dirlayout.html
  http://jakarta.apache.org/site/guidelines.html
  http://jakarta.apache.org/site/agreement.html

5.- Code quality
  Add copyright notice, add authors.
  Format your code but not others'.

  http://jakarta.apache.org/site/agreement.html
  http://xml.apache.org/source.html

6.- Testing
  Adding test cases.
  Solving bugs, errors, showstoppers.
  Security problems.

  http://httpd.apache.org/security_report.html

7.- Build system
  Use Ant, use Ant, use Ant.
  Use Gump.
  Use Scarab.

  Not done yet.

8.- Dependencies
  What jar's to use and what to avoid.

  http://jakarta.apache.org/site/jars.html

9.- Documentation
  Where to look for it.
  What to expect, what not to expect.

  Not done yet.

10.- Releases
  When to release, what to release.
  Release process.

  http://jakarta.apache.org/site/binindex.html

11.- Support
  Whom you should ask, what you should figure out yourself.

  http://jakarta.apache.org/site/mail.html
  http://xml.apache.org/mail.html

12.- 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.

  http://www.apache.org/foundation/licence-FAQ.html
  http://xml.apache.org/dist/LICENSE.txt

> -----Mensaje original-----
> De: Marc Saegesser [mailto:[EMAIL PROTECTED]]
> Enviado el: miércoles 20 de febrero de 2002 20:19
> Para: Jakarta General List
> Asunto: RE: Apache Manual (was ApacheForge)
> 
> 
> 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 
> 

Reply via email to