incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r437687 - in /incubator/public/trunk: site-author/guides/releasemanagement.xml site-publish/guides/releasemanagement.html
Date Mon, 28 Aug 2006 12:33:30 GMT
Author: rdonkin
Date: Mon Aug 28 05:33:28 2006
New Revision: 437687

URL: http://svn.apache.org/viewvc?rev=437687&view=rev
Log:
Added content. Added TODO for content needed.

Modified:
    incubator/public/trunk/site-author/guides/releasemanagement.xml
    incubator/public/trunk/site-publish/guides/releasemanagement.html

Modified: incubator/public/trunk/site-author/guides/releasemanagement.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/releasemanagement.xml?rev=437687&r1=437686&r2=437687&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/releasemanagement.xml (original)
+++ incubator/public/trunk/site-author/guides/releasemanagement.xml Mon Aug 28 05:33:28 2006
@@ -53,6 +53,11 @@
 not only on the project but also the foundation as a whole. 
         </p>
 		</section>
+		<section name='apache-releases'><title>Organisation</title>
+			<p>
+			TODO: describe organisation of this document.
+			</p>
+		</section>
         <section id='help'><title>Help Wanted!</title>
     <p>
 Help to finish this document by contributing documentation patches to the incubator general
list!
@@ -101,11 +106,24 @@
 <strong>Note</strong> this is not intended to replace an understanding of the
release process.
         </p>
         <ul>
-            <li><a href='#artifact'>Distributed Artifacts</a>
+            <li><a href='#glossary-distributions'>Distributions</a>
+                <ul>
+                    <li>Check compressed distributions <a href='#best-practice-formats'>unpack
correctly</a></li>
+                </ul>
+            </li>
+            <li><a href='#glossary-artifact'>Distributed Artifacts</a>
                 <ul>
                     <li>Check <a href='#license'>LICENSE</a> and <a
href='#notice'>NOTICE</a> files.</li>
                 </ul>
             </li>
+            <li><a href='#glossary-source-distribution'>Source Distribution</a>
+            	<ul>
+            		<li>Check source <a href='#best-practice-source-build'>builds</a></li>
+            		<li>Check <a href='glossary-license-headers'>license headers</a>

+            		are <a href='notes-license-headers'>correctly applied</a></li>
+            		<li>Check for <a href='#best-practice-source'>version control</a>
files</li>
+            	</ul>
+            </li>
         </ul>
     </section>
     <section id='rules'><title>Rules</title>
@@ -123,8 +141,8 @@
             </p>
         </section>
     </section>
-    <section id='best practice'><title>Best Practice</title>
-        <section id='jars'><title>Jars</title>
+    <section id='best-practice'><title>Best Practice</title>
+        <section id='best-practice-jars'><title>Jars</title>
             <ul>
                 <li><code>META-INF</code>
                     <ul>
@@ -139,13 +157,51 @@
                 </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.
+        <section id='best-practice-types'><title>Distribution Types</title>
+        	<p>
+ TODO: glossay - distribution type: based on the same tagged source built  
+ TODO: Common Types of distribtuion
+ TODO: the source distribution is canonical. every project should create a source distribution.
+ compiled languages may also wish to create binary releases. these may be platform specific.
+ some project may also convenience types which package the project for particular containers.
+        	</p>
+        </section>
+           <section id='best-practice-downstream'><title>Downstream Packagers</title>
+        	<p>
+ TODO: glossay - downstream packager: takes an apache release and packages it for a particular
platform.
+ TODO: best practice is to work with downstream packagers and link to their packages
+ rather than roll own packages. need to add notes that these are not official releases.
+ TODO: link to notes on working with downstream packagers
+        	</p>
+        </section>    
+        <section id='best-practice-source'><title>Source Distributions</title>
+        	<p>
+        	TODO: describe what a source distribution is; version control for distributions;

+        	add content to release documents; export not checkout
+        	</p>
+        </section>
+        <section id='best-practice-formats'><title>Formats</title>
+            <p>
+TODO source verses binary, *nix (tgz and b) and windows (zip). 
+See <a href='notes-line-endings'>notes</a> on line endings for source distributions.
+            </p>
+            <p>
+Different <a href='#best-practice-types'>distribution types</a> should unpack
to 
+directories with different names. This is more convenient for users since:
+			</p>
+			<ul>
+				<li>users who download more than one type do not need to 
+				take action to ensure that unpacked distributions do not overwrite each other</li>
+				<li>it allows easy identification of different distribution types</li>
+			</ul>
+			<p>
+For project, <em>Apache Foo</em> (say) with source and binary types, it is conventional
for the main binary
+to unpack to <code>apache-foo</code> and the source to <code>apache-foo-src</code>.
+Other binary types should unpack to suitably suffixed directories (for example, 
+<code>apache-foo-sdk</code>).
             </p>
+        </section>
+        <section id='best-practice-source-build'><title>Source Distribution Build</title>
             <p>
 Source distibutions should build. TODO: best practices for instructing users about building
the project.
             </p>
@@ -175,26 +231,72 @@
             TODO: Ship with source and binary
             </p>
         </section>
+        <section id='notes-on-line-endings'><title>On Line Endings</title>
+            <p>
+            TODO: windows vs *nix line endings. use svn to export. example.
+            </p>
+        </section>
+                <section id='notes-license-headers'><title>On License Headers</title>
+            <p>
+            TODO: links into legal documentation. discuss issues about which files need to
apply.
+            </p>
+            <p>
+            TODO: tool
+            </p>
+        </section>
+        
     </section>
     <section id='glossary'><title>Glossary</title>
-        <section id='artifact'><title>Distributed Artifact</title>
+        <section id='glossary-artifact'><title>Distributed Artifact</title>
             <p>
             TODO (include link to infra documentation)
             </p>
         </section>
-        <section id='license'><title>LICENSE file</title>
+        <section id='glossary-license'><title>LICENSE file</title>
             <p>
             TODO (include link to infra documentation)
             </p>
         </section>
-        <section id='notice'><title>NOTICE file</title>
+        <section id='glossary-notice'><title>NOTICE file</title>
             <p>
             TODO (include link to infra documentation)
             </p>
         </section>
-        <section id='notice'><title>Jar MANIFEST</title>
+        <section id='glossary-manifest'><title>Jar MANIFEST</title>
             <p>
             TODO link to sun documentation
+            </p>
+        </section>
+         <section id='glossary-license-header'><title>License Header</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-release-manager'><title>Release Manager</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-release-candidate'><title>Release Candidate</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-distribution'><title>Distribution</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-source-distribution'><title>Source Distribution</title>
+            <p>
+            TODO: (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-binary-distribution'><title>Binary Distribution</title>
+            <p>
+            TODO: (include link to infra documentation)
+            binary distributions include all types which are not source. 
+            one canonical source distribution, many binary distributions.
             </p>
         </section>
     </section>

Modified: incubator/public/trunk/site-publish/guides/releasemanagement.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/releasemanagement.html?rev=437687&r1=437686&r2=437687&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/releasemanagement.html (original)
+++ incubator/public/trunk/site-publish/guides/releasemanagement.html Mon Aug 28 05:33:28
2006
@@ -123,6 +123,14 @@
         </p>
 </div>
 <h3>
+   Organisation
+</h3>
+<div class="section-content">
+<p>
+			TODO: describe organisation of this document.
+			</p>
+</div>
+<h3>
    <a name="help">Help Wanted!</a>
 </h3>
 <div class="section-content">
@@ -179,11 +187,24 @@
 <strong>Note</strong> this is not intended to replace an understanding of the
release process.
         </p>
 <ul>
-            <li><a href="#artifact">Distributed Artifacts</a>
+            <li><a href="#glossary-distributions">Distributions</a>
+                <ul>
+                    <li>Check compressed distributions <a href="#best-practice-formats">unpack
correctly</a></li>
+                </ul>
+            </li>
+            <li><a href="#glossary-artifact">Distributed Artifacts</a>
                 <ul>
                     <li>Check <a href="#license">LICENSE</a> and <a
href="#notice">NOTICE</a> files.</li>
                 </ul>
             </li>
+            <li><a href="#glossary-source-distribution">Source Distribution</a>
+            	<ul>
+            		<li>Check source <a href="#best-practice-source-build">builds</a></li>
+            		<li>Check <a href="glossary-license-headers">license headers</a>

+            		are <a href="notes-license-headers">correctly applied</a></li>
+            		<li>Check for <a href="#best-practice-source">version control</a>
files</li>
+            	</ul>
+            </li>
         </ul>
 </div>
            <h2><img src="/images/redarrow.gif" />
@@ -208,11 +229,11 @@
 </div>
 </div>
            <h2><img src="/images/redarrow.gif" />
-   <a name="best practice">Best Practice</a>
+   <a name="best-practice">Best Practice</a>
 </h2>
 <div class="section-content">
 <h3>
-   <a name="jars">Jars</a>
+   <a name="best-practice-jars">Jars</a>
 </h3>
 <div class="section-content">
 <ul>
@@ -230,15 +251,65 @@
             </ul>
 </div>
 <h3>
-   <a name="formats">Formats</a>
+   <a name="best-practice-types">Distribution Types</a>
+</h3>
+<div class="section-content">
+<p>
+ TODO: glossay - distribution type: based on the same tagged source built  
+ TODO: Common Types of distribtuion
+ TODO: the source distribution is canonical. every project should create a source distribution.
+ compiled languages may also wish to create binary releases. these may be platform specific.
+ some project may also convenience types which package the project for particular containers.
+        	</p>
+</div>
+<h3>
+   <a name="best-practice-downstream">Downstream Packagers</a>
+</h3>
+<div class="section-content">
+<p>
+ TODO: glossay - downstream packager: takes an apache release and packages it for a particular
platform.
+ TODO: best practice is to work with downstream packagers and link to their packages
+ rather than roll own packages. need to add notes that these are not official releases.
+ TODO: link to notes on working with downstream packagers
+        	</p>
+</div>
+<h3>
+   <a name="best-practice-source">Source Distributions</a>
+</h3>
+<div class="section-content">
+<p>
+        	TODO: describe what a source distribution is; version control for distributions;

+        	add content to release documents; export not checkout
+        	</p>
+</div>
+<h3>
+   <a name="best-practice-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.
+TODO source verses binary, *nix (tgz and b) and windows (zip). 
+See <a href="notes-line-endings">notes</a> 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.
+Different <a href="#best-practice-types">distribution types</a> should unpack
to 
+directories with different names. This is more convenient for users since:
+			</p>
+<ul>
+				<li>users who download more than one type do not need to 
+				take action to ensure that unpacked distributions do not overwrite each other</li>
+				<li>it allows easy identification of different distribution types</li>
+			</ul>
+<p>
+For project, <em>Apache Foo</em> (say) with source and binary types, it is conventional
for the main binary
+to unpack to <code>apache-foo</code> and the source to <code>apache-foo-src</code>.
+Other binary types should unpack to suitably suffixed directories (for example, 
+<code>apache-foo-sdk</code>).
             </p>
+</div>
+<h3>
+   <a name="best-practice-source-build">Source Distribution Build</a>
+</h3>
+<div class="section-content">
 <p>
 Source distibutions should build. TODO: best practices for instructing users about building
the project.
             </p>
@@ -280,13 +351,32 @@
             TODO: Ship with source and binary
             </p>
 </div>
+<h3>
+   <a name="notes-on-line-endings">On Line Endings</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: windows vs *nix line endings. use svn to export. example.
+            </p>
+</div>
+<h3>
+   <a name="notes-license-headers">On License Headers</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: links into legal documentation. discuss issues about which files need to
apply.
+            </p>
+<p>
+            TODO: tool
+            </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>
+   <a name="glossary-artifact">Distributed Artifact</a>
 </h3>
 <div class="section-content">
 <p>
@@ -294,7 +384,7 @@
             </p>
 </div>
 <h3>
-   <a name="license">LICENSE file</a>
+   <a name="glossary-license">LICENSE file</a>
 </h3>
 <div class="section-content">
 <p>
@@ -302,7 +392,7 @@
             </p>
 </div>
 <h3>
-   <a name="notice">NOTICE file</a>
+   <a name="glossary-notice">NOTICE file</a>
 </h3>
 <div class="section-content">
 <p>
@@ -310,11 +400,61 @@
             </p>
 </div>
 <h3>
-   <a name="notice">Jar MANIFEST</a>
+   <a name="glossary-manifest">Jar MANIFEST</a>
 </h3>
 <div class="section-content">
 <p>
             TODO link to sun documentation
+            </p>
+</div>
+<h3>
+   <a name="glossary-license-header">License Header</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-release-manager">Release Manager</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-release-candidate">Release Candidate</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-distribution">Distribution</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-source-distribution">Source Distribution</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-binary-distribution">Binary Distribution</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: (include link to infra documentation)
+            binary distributions include all types which are not source. 
+            one canonical source distribution, many binary distributions.
             </p>
 </div>
 </div>



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


Mime
View raw message