incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r413751 - in /incubator/public/trunk: site-author/learn/releasemanagement.xml site-publish/learn/releasemanagement.html
Date Mon, 12 Jun 2006 22:04:57 GMT
Author: rdonkin
Date: Mon Jun 12 15:04:56 2006
New Revision: 413751

URL: http://svn.apache.org/viewvc?rev=413751&view=rev
Log:
Very rough first draft of a release management page. Intentionally releasing early to encourage
people to dive in with improvements.

Added:
    incubator/public/trunk/site-author/learn/releasemanagement.xml
    incubator/public/trunk/site-publish/learn/releasemanagement.html

Added: incubator/public/trunk/site-author/learn/releasemanagement.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/learn/releasemanagement.xml?rev=413751&view=auto
==============================================================================
--- incubator/public/trunk/site-author/learn/releasemanagement.xml (added)
+++ incubator/public/trunk/site-author/learn/releasemanagement.xml Mon Jun 12 15:04:56 2006
@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>Apache Incubator: Release Management (DRAFT)</title>
+  </properties>
+  <body>
+    <section id='intro'><title>Apache Release Management (DRAFT)</title>
+    
+        <p>
+TODO: Intro Release management at the ASF involves more ceremony that many other Apache processes.

+There are good reasons for this: 
+    <ul>
+        <li>publishing software has legal consequences TODO: more?</li>
+        <li>most users interact with the ASF just through it's releases - 
+        they are the public face of your project.</li>
+    </ul>
+        </p>
+        <p>
+TODO: move consequences section up here?
+        </p>
+        <p>
+<strong>Note</strong> this document is <strong>not</strong> normative.
TODO: explain descriptive status
+        </p>
+        <section id='help'><title>Help Wanted!</title>
+    <p>
+Help to finish this document by contributing documentation patches to the incubator general
list!
+If the information you seek isn't in this document, 
+then please submit a patch once the incubator folks have answered your question.
+    </p>
+    <p>
+<strong>Best Practice Needs You!</strong> This document aims to collect best
practice amongst
+Apache projects, not to disseminate some wisdom from on high. If you know some good release
practice
+that isn't included then please ask for karma or submit a patch. Different options or opinions

+are encouraged.
+    </p>
+    </section>
+    </section>
+    <section id='guidelines'><title>Guidelines</title>
+        <p>
+It is strong recommended that a project creates it's own release guidelines. The actual 
+<a href='rules'>minimum</a> required by the ASF is reasonable small but subtle.
However,
+the traditional standards for ASF releases are quite high. 
+        </p>
+                <p>
+This document is not normative. It should not be seen as a recipe for definitive ASF releases.
It is
+strongly recommended that podlings create their own release guidelines. Hopefully the incubator
documentation
+may help to shorten the process of creating good release guidelines for the podling by providing

+options, highlighting issues and providing templates.
+        </p>
+        <p>
+There is great variety amongst existing Apache project. Diversity is good. 
+        </p>
+        <p>
+There is inevitably a conflict between the excellent advice to release often and the documentation
+required to create good releases.
+        </p>
+        <ul>
+            <li>
+        ASF releases are high visibility and long lived. A release manager may find that
a 
+        poor quality release may be held up as an example for years to come.
+            </li>
+            <li>
+        TODO: legal consequences
+            </li>
+        </ul>
+    </section>
+    <section id='check-list'><title>Check List</title>
+        <p>
+<strong>Note</strong> this is not intended to replace an understanding of the
release process.
+        </p>
+        <ul>
+            <li><a href='#artifact'>Distributed Artifacts</a>
+                <ul>
+                    <li>Check <a href='#license'>LICENSE</a> and <a
href='#notice'>NOTICE</a> files.</li>
+                </ul>
+            </li>
+        </ul>
+    </section>
+    <section id='rules'><title>Rules</title>
+        <p>
+        TODO release votes by pmc, legal rules, infrastructure rules. Use links so information
is maintained 
+        in only one place.
+        </p>
+        <section id='naming'>Naming<title></title>
+            <p>
+            TODO: incubator rules
+            </p>
+            <p>
+            TODO: should include apache in the title (gives trademark protection against
different jars 
+            with the same name)
+            </p>
+        </section>
+    </section>
+    <section id='best practice'><title>Best Practice</title>
+        <section id='jars'><title>Jars</title>
+            <ul>
+                <li><code>META-INF</code>
+                    <ul>
+                        <li>
+    Should include <a href='#license'>LICENSE</a> and <a href='#NOTICE'>NOTICE</a>.

+    Note <a href='#distributing-jars'>this</a>
+                        </li>
+                        <li>
+    Should include a standards compliant MANIFEST. Note <a href='#jar-manifest'>this</a>.
+                        </li>
+                    </ul>
+                </li>
+            </ul>
+        </section>
+        <section id='formats'><title>Formats</title>
+            <p>
+TODO source verses binary, *nix (tgz and b) and windows (zip). notes on line endings for
source distributions.
+            </p>
+            <p>
+Binary and Source distributions should unpack to directories with different names. For example
apache-foo and apache-foo-src.
+            </p>
+            <p>
+Source distibutions should build. TODO: best practices for instructing users about building
the project.
+            </p>
+        </section>
+    </section>
+    <section id='notes'><title>Notes</title>
+        <section id='distributing-jars'><title>Distributing Jars</title>
+            <p>
+            TODO
+            </p>
+        </section>
+        <section id='jar-manifest'><title>Jar MANIFEST</title>
+            <p>
+TODO
+Lots of projects get this wrong and (by default) most tools produce substandard manifests.
+Offer some guidance on values
+            </p>
+        </section>
+        <section id='release-notes'><title>Release Notes</title>
+            <p>
+            TODO: text is best. Every release should have them and should be positioned in
the base directory
+            </p>
+            <p>
+            TODO: contents
+            </p>
+            <p>
+            TODO: Ship with source and binary
+            </p>
+        </section>
+    </section>
+    <section id='glossary'><title>Glossary</title>
+        <section id='artifact'><title>Distributed Artifact</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='license'><title>LICENSE file</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='notice'><title>NOTICE file</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='notice'><title>Jar MANIFEST</title>
+            <p>
+            TODO link to sun documentation
+            </p>
+        </section>
+    </section>
+  </body>
+</document>

Added: incubator/public/trunk/site-publish/learn/releasemanagement.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/learn/releasemanagement.html?rev=413751&view=auto
==============================================================================
--- incubator/public/trunk/site-publish/learn/releasemanagement.html (added)
+++ incubator/public/trunk/site-publish/learn/releasemanagement.html Mon Jun 12 15:04:56 2006
@@ -0,0 +1,315 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+               "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+Copyright 1999-2006 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<html>
+ <head>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="/style/style.css" type="text/css" />
+      <title>Apache Incubator: Release Management (DRAFT) - Apache Incubator</title>
+ </head>
+ <body>        
+  <table border="0" width="100%" cellspacing="0">
+   <tr><!-- SITE BANNER AND PROJECT IMAGE -->
+    <td align="left" valign="top">
+<a href="http://www.apache.org/"><img src="/images/asf_logo_wide.gif" alt="The Apache
Software Foundation" border="0"/></a>
+</td>
+<td align="right">
+<a href="http://incubator.apache.org/"><img src="../images/apache-incubator-logo.png"
alt="Apache Incubator" border="0"/></a>
+</td>
+   </tr>
+  </table>
+  <table border="0" width="100%" cellspacing="4">
+   <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
+   <tr>
+    <!-- LEFT SIDE NAVIGATION -->
+    <td valign="top" nowrap="nowrap" class="navleft">
+           <div class="menuheader">General</div>
+    <menu compact="compact">
+          <li><a href="/index.html">Home</a></li> 
+          <li><a href="/resolution.html">What We Do</a></li> 
+          <li><a href="/howwework.html">How We Work</a></li> 
+          <li><a href="/whoweare.html">Who We Are</a></li> 
+          <li><a href="/howtoparticipate.html">How To Participate</a></li>

+          <li><a href="/faq.html">FAQ</a></li> 
+          <li><a href="http://wiki.apache.org/incubator">Wiki</a></li>

+        </menu>
+      <div class="menuheader">Incubation</div>
+    <menu compact="compact">
+          <li><a href="/projects/index.html">Projects</a></li> 
+          <li><a href="/ip-clearance/index.html">IP Clearance</a></li>

+          <li><a href="/incubation/Incubation_Policy.html">Incubation Policy</a></li>

+          <li><a href="/incubation/Process_Description.html">Process Description</a></li>

+          <li><a href="/incubation/Roles_and_Responsibilities.html">Roles/Responsibilies</a></li>

+        </menu>
+      <div class="menuheader">Guides</div>
+    <menu compact="compact">
+          <li><a href="/guides/general.html">General</a></li> 
+          <li><a href="/guides/committer.html">Committers</a></li>

+          <li><a href="/guides/chair.html">Chair</a></li> 
+          <li><a href="/guides/pmc.html">PMC</a></li> 
+          <li><a href="/guides/projects.html">Projects and Mentors</a></li>

+          <li><a href="/guides/website.html">Updating the Website</a>
+      <p><a href="http://www.eu.apachecon.com"><img src="http://www.eu.apachecon.com/konferenzen/apachecon06/images/header-left.gif"
alt="ApacheCon Europe 2006" title="ApacheCon Europe 2006" width="120" height="50" /></a></p>
+      </li> 
+        </menu>
+    </td>
+    <!-- CONTENT -->
+    <td align="left" valign="top" class="content">
+                <h2><img src="/images/redarrow.gif" />
+   <a name="intro">Apache Release Management (DRAFT)</a>
+</h2>
+<div class="section-content">
+<p>
+TODO: Intro Release management at the ASF involves more ceremony that many other Apache processes.

+There are good reasons for this: 
+    <ul>
+        <li>publishing software has legal consequences TODO: more?</li>
+        <li>most users interact with the ASF just through it's releases - 
+        they are the public face of your project.</li>
+    </ul>
+        </p>
+<p>
+TODO: move consequences section up here?
+        </p>
+<p>
+<strong>Note</strong> this document is <strong>not</strong> normative.
TODO: explain descriptive status
+        </p>
+<h3>
+   <a name="help">Help Wanted!</a>
+</h3>
+<div class="section-content">
+<p>
+Help to finish this document by contributing documentation patches to the incubator general
list!
+If the information you seek isn't in this document, 
+then please submit a patch once the incubator folks have answered your question.
+    </p>
+<p>
+<strong>Best Practice Needs You!</strong> This document aims to collect best
practice amongst
+Apache projects, not to disseminate some wisdom from on high. If you know some good release
practice
+that isn't included then please ask for karma or submit a patch. Different options or opinions

+are encouraged.
+    </p>
+</div>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="guidelines">Guidelines</a>
+</h2>
+<div class="section-content">
+<p>
+It is strong recommended that a project creates it's own release guidelines. The actual 
+<a href="rules">minimum</a> required by the ASF is reasonable small but subtle.
However,
+the traditional standards for ASF releases are quite high. 
+        </p>
+<p>
+This document is not normative. It should not be seen as a recipe for definitive ASF releases.
It is
+strongly recommended that podlings create their own release guidelines. Hopefully the incubator
documentation
+may help to shorten the process of creating good release guidelines for the podling by providing

+options, highlighting issues and providing templates.
+        </p>
+<p>
+There is great variety amongst existing Apache project. Diversity is good. 
+        </p>
+<p>
+There is inevitably a conflict between the excellent advice to release often and the documentation
+required to create good releases.
+        </p>
+<ul>
+            <li>
+        ASF releases are high visibility and long lived. A release manager may find that
a 
+        poor quality release may be held up as an example for years to come.
+            </li>
+            <li>
+        TODO: legal consequences
+            </li>
+        </ul>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="check-list">Check List</a>
+</h2>
+<div class="section-content">
+<p>
+<strong>Note</strong> this is not intended to replace an understanding of the
release process.
+        </p>
+<ul>
+            <li><a href="#artifact">Distributed Artifacts</a>
+                <ul>
+                    <li>Check <a href="#license">LICENSE</a> and <a
href="#notice">NOTICE</a> files.</li>
+                </ul>
+            </li>
+        </ul>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="rules">Rules</a>
+</h2>
+<div class="section-content">
+<p>
+        TODO release votes by pmc, legal rules, infrastructure rules. Use links so information
is maintained 
+        in only one place.
+        </p>
+<h3>
+   <a name="naming"></a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: incubator rules
+            </p>
+<p>
+            TODO: should include apache in the title (gives trademark protection against
different jars 
+            with the same name)
+            </p>
+</div>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="best practice">Best Practice</a>
+</h2>
+<div class="section-content">
+<h3>
+   <a name="jars">Jars</a>
+</h3>
+<div class="section-content">
+<ul>
+                <li><code>META-INF</code>
+                    <ul>
+                        <li>
+    Should include <a href="#license">LICENSE</a> and <a href="#NOTICE">NOTICE</a>.

+    Note <a href="#distributing-jars">this</a>
+                        </li>
+                        <li>
+    Should include a standards compliant MANIFEST. Note <a href="#jar-manifest">this</a>.
+                        </li>
+                    </ul>
+                </li>
+            </ul>
+</div>
+<h3>
+   <a name="formats">Formats</a>
+</h3>
+<div class="section-content">
+<p>
+TODO source verses binary, *nix (tgz and b) and windows (zip). notes on line endings for
source distributions.
+            </p>
+<p>
+Binary and Source distributions should unpack to directories with different names. For example
apache-foo and apache-foo-src.
+            </p>
+<p>
+Source distibutions should build. TODO: best practices for instructing users about building
the project.
+            </p>
+</div>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="notes">Notes</a>
+</h2>
+<div class="section-content">
+<h3>
+   <a name="distributing-jars">Distributing Jars</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO
+            </p>
+</div>
+<h3>
+   <a name="jar-manifest">Jar MANIFEST</a>
+</h3>
+<div class="section-content">
+<p>
+TODO
+Lots of projects get this wrong and (by default) most tools produce substandard manifests.
+Offer some guidance on values
+            </p>
+</div>
+<h3>
+   <a name="release-notes">Release Notes</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: text is best. Every release should have them and should be positioned in
the base directory
+            </p>
+<p>
+            TODO: contents
+            </p>
+<p>
+            TODO: Ship with source and binary
+            </p>
+</div>
+</div>
+           <h2><img src="/images/redarrow.gif" />
+   <a name="glossary">Glossary</a>
+</h2>
+<div class="section-content">
+<h3>
+   <a name="artifact">Distributed Artifact</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="license">LICENSE file</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="notice">NOTICE file</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="notice">Jar MANIFEST</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO link to sun documentation
+            </p>
+</div>
+</div>
+         </td>
+    <!-- RIGHT SIDE NAVIGATION -->
+    <td valign="top" nowrap="nowrap" class="navright">
+           <div class="menuheader"><a 
+href="http://www.apache.org/foundation/">Foundation site</a></div>
+    <menu compact="compact">
+        </menu>
+      <div class="menuheader"><a 
+href="http://www.apache.org/licenses/">Licensing site</a></div>
+    <menu compact="compact">
+        </menu>
+
+<form action="http://www.google.com/search" method="get">
+    <input value="incubator.apache.org" name="sitesearch" type="hidden"/>
+    <input size="8" name="q" id="query" type="text" value="search..."
+        onclick="if(this.value == 'search...') {this.value = ''}"/>
+    <input name="Search" value="Go" type="submit"/>
+</form>
+    </td>     
+   </tr>
+   <!-- FOOTER -->
+   <tr><td colspan="3"><hr noshade="noshade" size="1"/></td></tr>
+   <tr><td colspan="3" class="footer">
+         Copyright &#169; 1999-2006, The Apache Software Foundation<br />
+Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License,
Version 2.0</a>.
+       </td>
+   </tr>
+  </table>
+ </body>
+</html>



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message