jon 02/02/22 17:16:45
Added: xdocs/site methodology.xml
Log:
added this methodology based on discussion on the general@ list
thanks to:
"Fernandez Martinez, Alejandro" <[EMAIL PROTECTED]>
Revision Changes Path
1.1 jakarta-site2/xdocs/site/methodology.xml
Index: methodology.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Alex Fern�ndez</author>
<title>Jakarta Methodology</title>
</properties>
<body>
<section name="Apache Manual">
<a name="way">
<h3>Purpose of this document</h3>
</a>
<p>
It all began in [EMAIL PROTECTED]
</p>
<p>
At the request of an "Apache Manual", where the Apache process is
documented, <a href="mailto:[EMAIL PROTECTED]";>Jon Scott Stevens</a>
writes:
</p>
<blockquote>
<p>
Because it would take a HUGE amount of effort to create and maintain a
manual like that. The people who know the manual don't have the itch to
create the manual because there is always people who are coming along who
have enough of a clue and drive to figure out the manual on their own. Nice
catch-22.
</p>
<p>
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.
</p>
</blockquote>
<p>
<a href="mailto:[EMAIL PROTECTED]";>Paul Hammant</a> showed his good
disposition for writing such an Apache Manual, where the process and
methodology is documented as an outstanding example of a successful
open-source process.
</p>
<p>
At this point, the page is just a table of contents and some links,
reflecting the contributions of both Jon and <a
href="mailto:[EMAIL PROTECTED]";>Marc Saegesser</a>. It should
be updated to encompass all interesting aspects of the Apache (and more
specifically Jakarta) way.
</p>
</section>
<section name="Following the Jakarta way">
<a name="way">
<h2>Table of contents</h2>
</a>
<ul>
<li><h3>Introduction</h3>
<p>
Who we are, why are we doing this.
</p>
<p>
<a href="http://jakarta.apache.org/site/whoweare.html";>Who we are</a><br/>
<a href="http://xml.apache.org/whoweare.html";>Who xml.apache.org are</a><br/>
<a href="http://httpd.apache.org/ABOUT_APACHE.html";>Who httpd.apache.org are</a>
</p>
</li>
<li><h3>Project proposal</h3>
<p>
Proposal stage, committers needed, community.
</p>
<p>
<a href="http://jakarta.apache.org/site/getinvolved.html";>Community</a><br/>
<a href="http://jakarta.apache.org/site/newproject.html";>Proposals for new
projects</a>
</p>
</li>
<li><h3>Apache rules</h3>
<p>
Who gets to vote what.<br/>
Voting rules, valid votes, +1/+0/0/-0/-1.
</p>
<p>
<a href="http://jakarta.apache.org/site/roles.html";>Project roles</a><br/>
<a href="http://jakarta.apache.org/site/decisions.html";>Who votes what</a><br/>
<a href="http://xml.apache.org/roles.html";>xml.apache.org roles</a><br/>
<a href="http://xml.apache.org/decisions.html";>xml.apache.org decisions</a><br/>
<a href="http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt";>xml.apache.org
charter</a>
</p>
</li>
<li><h3>Code organization and repositories</h3>
<p>
Naming of packages, repositories, what to find in them.<br/>
Who touches what.
</p>
<p>
<a href="http://jakarta.apache.org/site/dirlayout.html";>Directory layout</a><br/>
<a href="http://jakarta.apache.org/site/guidelines.html";>Project
guidelines</a><br/>
<a href="http://jakarta.apache.org/site/agreement.html";>Committer agreement</a>
</p>
</li>
<li><h3>Code quality</h3>
<p>
Add copyright notice, add authors.<br/>
Format your code but not others'.
</p>
<p>
<a href="http://jakarta.apache.org/site/agreement.html";>Committer
agreement</a><br/>
<a href="http://xml.apache.org/source.html";>xml.apache.org source code</a>
</p>
</li>
<li><h3>Testing</h3>
<p>
Adding test cases.<br/>
Solving bugs, errors, showstoppers.<br/>
Security problems.
</p>
<p>
<a href="http://httpd.apache.org/security_report.html";>httpd security problems</a>
</p>
</li>
<li><h3>Build system</h3>
<p>
Use Ant, use Ant, use Ant.<br/>
Use Gump.<br/>
Use Scarab.
</p>
<p>
Not done yet.
</p>
</li>
<li><h3>Dependencies</h3>
<p>
<a href="http://jakarta.apache.org/site/jars.html";>What jar's to use
and what to avoid.</a>
</p>
</li>
<li><h3>Documentation</h3>
<p>
Where to look for it.<br/>
What to expect, what not to expect.
</p>
<p>
Not done yet.
</p>
</li>
<li><h3>Releases</h3>
<p>
When to release, what to release.<br/>
Release process.
</p>
<p>
<a href="http://jakarta.apache.org/site/binindex.html";>Release flavors</a>
</p>
</li>
<li><h3>Support</h3>
Whom you should ask, what you should figure out yourself.
<p>
<a href="http://jakarta.apache.org/site/mail.html";>Mail guidelines</a><br/>
<a href="http://xml.apache.org/mail.html";>xml.apache.org guidelines</a>
</p>
</li>
<li><h3>Licensing and guarantee</h3>
<p>
Why you should use Apache license, and what's wrong with other licenses.<br/>
What you can do with Apache products. Giving credit.<br/>
All that implied warranty things.
</p>
<p>
<a href="http://www.apache.org/foundation/licence-FAQ.html";>The Apache license
FAQ</a><br/>
<a href="http://xml.apache.org/dist/LICENSE.txt";>The Apache license</a>
</p>
</li>
</ul>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
