incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r437694 - in /incubator/public/trunk: site-author/guides/releasemanagement.xml site-publish/guides/releasemanagement.html
Date Mon, 28 Aug 2006 13:10:03 GMT
Author: rdonkin
Date: Mon Aug 28 06:10:02 2006
New Revision: 437694

URL: http://svn.apache.org/viewvc?rev=437694&view=rev
Log:
Added more content and TODOs.

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=437694&r1=437693&r2=437694&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/releasemanagement.xml (original)
+++ incubator/public/trunk/site-author/guides/releasemanagement.xml Mon Aug 28 06:10:02 2006
@@ -109,6 +109,15 @@
             <li><a href='#glossary-distributions'>Distributions</a>
                 <ul>
                     <li>Check compressed distributions <a href='#best-practice-formats'>unpack
correctly</a></li>
+                    <li>Check documentation is readable</li>
+                    <li>Check <a href='best-practice-distributing-libraries'>distributed
libraries</a>
+                    	<ul>
+	                    	<li>Check licenses for libraries are distributed together with
any applicable 
+	                    	<a href='best-practice-notice'>NOTICEs</a> TODO: link</li>
+                    		<li>Check that licenses comply with incubator policy TODO: link</li>
+                    		<li>Check that licenses comply with project policy TODO: link</li>
               		
+                    	</ul>
+                    </li>
                 </ul>
             </li>
             <li><a href='#glossary-artifact'>Distributed Artifacts</a>
@@ -118,7 +127,8 @@
             </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 build instructions exist and that source <a href='#best-practice-source-build'>builds</a>
+            		using these instructions</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>
@@ -202,9 +212,37 @@
             </p>
         </section>
         <section id='best-practice-source-build'><title>Source Distribution Build</title>
+        	<p>
+This section applies only to compiled languages.
+        	</p>
+            <p>
+Source distributions should contain easy instructions describing how to build the project.
+The source distribution should build from instructions contained. 
+TODO: best practices for instructing users about building the project.
+            </p>
+        </section>
+        <section id='best-practice-distributing-libraries'><title>Distributing
Libraries</title>
             <p>
-Source distibutions should build. TODO: best practices for instructing users about building
the project.
+TODO: ASF policy compliance
+TODO: project policy - explicit policy should be written down
             </p>
+            <p>
+TODO: Discussion on the merits of distributing dependent jars. 
+            </p>
+        </section>
+        <section id='best-practice-notice'><title>NOTICE files</title>
+        	<p>
+ TODO: links to infra
+        	</p>
+        	<p>
+ Discuss about what's appropriate for NOTICE files. 
+        	</p>
+        </section>
+        <section id='best-practices'><title>Dependencies</title>
+        	<p>
+TODO: versions should be clearly indicated
+TODO: java version with indication in MANIFEST (link to note)
+        	</p>
         </section>
     </section>
     <section id='notes'><title>Notes</title>
@@ -236,15 +274,23 @@
             TODO: windows vs *nix line endings. use svn to export. example.
             </p>
         </section>
-                <section id='notes-license-headers'><title>On License Headers</title>
+        <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>
+            <p>
+The issue of licenses on generated documentation is a little controversial. Copyright may
not subsist
+in a document which is generated by an transformation from an original. In which case, the
license header
+may be unnecessary. License headers should always be present in the original. Where it is

+reasonable to do so, the templates should also add the license header to the generated documents.
+            </p>
+            <p>
+TODO: check with legal-discuss then move this content into the legal pages and link with
commentary
+            </p>
         </section>
-        
     </section>
     <section id='glossary'><title>Glossary</title>
         <section id='glossary-artifact'><title>Distributed Artifact</title>
@@ -269,7 +315,7 @@
         </section>
          <section id='glossary-license-header'><title>License Header</title>
             <p>
-            TODO (include link to infra documentation)
+            TODO (include link to legal documentation)
             </p>
         </section>
         <section id='glossary-release-manager'><title>Release Manager</title>

Modified: incubator/public/trunk/site-publish/guides/releasemanagement.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/releasemanagement.html?rev=437694&r1=437693&r2=437694&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/releasemanagement.html (original)
+++ incubator/public/trunk/site-publish/guides/releasemanagement.html Mon Aug 28 06:10:02
2006
@@ -190,6 +190,15 @@
             <li><a href="#glossary-distributions">Distributions</a>
                 <ul>
                     <li>Check compressed distributions <a href="#best-practice-formats">unpack
correctly</a></li>
+                    <li>Check documentation is readable</li>
+                    <li>Check <a href="best-practice-distributing-libraries">distributed
libraries</a>
+                    	<ul>
+	                    	<li>Check licenses for libraries are distributed together with
any applicable 
+	                    	<a href="best-practice-notice">NOTICEs</a> TODO: link</li>
+                    		<li>Check that licenses comply with incubator policy TODO: link</li>
+                    		<li>Check that licenses comply with project policy TODO: link</li>
               		
+                    	</ul>
+                    </li>
                 </ul>
             </li>
             <li><a href="#glossary-artifact">Distributed Artifacts</a>
@@ -199,7 +208,8 @@
             </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 build instructions exist and that source <a href="#best-practice-source-build">builds</a>
+            		using these instructions</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>
@@ -311,9 +321,46 @@
 </h3>
 <div class="section-content">
 <p>
-Source distibutions should build. TODO: best practices for instructing users about building
the project.
+This section applies only to compiled languages.
+        	</p>
+<p>
+Source distributions should contain easy instructions describing how to build the project.
+The source distribution should build from instructions contained. 
+TODO: best practices for instructing users about building the project.
             </p>
 </div>
+<h3>
+   <a name="best-practice-distributing-libraries">Distributing Libraries</a>
+</h3>
+<div class="section-content">
+<p>
+TODO: ASF policy compliance
+TODO: project policy - explicit policy should be written down
+            </p>
+<p>
+TODO: Discussion on the merits of distributing dependent jars. 
+            </p>
+</div>
+<h3>
+   <a name="best-practice-notice">NOTICE files</a>
+</h3>
+<div class="section-content">
+<p>
+ TODO: links to infra
+        	</p>
+<p>
+ Discuss about what's appropriate for NOTICE files. 
+        	</p>
+</div>
+<h3>
+   <a name="best-practices">Dependencies</a>
+</h3>
+<div class="section-content">
+<p>
+TODO: versions should be clearly indicated
+TODO: java version with indication in MANIFEST (link to note)
+        	</p>
+</div>
 </div>
            <h2><img src="/images/redarrow.gif" />
    <a name="notes">Notes</a>
@@ -369,6 +416,15 @@
 <p>
             TODO: tool
             </p>
+<p>
+The issue of licenses on generated documentation is a little controversial. Copyright may
not subsist
+in a document which is generated by an transformation from an original. In which case, the
license header
+may be unnecessary. License headers should always be present in the original. Where it is

+reasonable to do so, the templates should also add the license header to the generated documents.
+            </p>
+<p>
+TODO: check with legal-discuss then move this content into the legal pages and link with
commentary
+            </p>
 </div>
 </div>
            <h2><img src="/images/redarrow.gif" />
@@ -412,7 +468,7 @@
 </h3>
 <div class="section-content">
 <p>
-            TODO (include link to infra documentation)
+            TODO (include link to legal documentation)
             </p>
 </div>
 <h3>



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


Mime
View raw message