incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r639999 - in /incubator/public/trunk: site-author/guides/mentor.xml site-publish/guides/mentor.html
Date Sat, 22 Mar 2008 14:05:36 GMT
Author: rdonkin
Date: Sat Mar 22 07:05:35 2008
New Revision: 639999

URL: http://svn.apache.org/viewvc?rev=639999&view=rev
Log:
Post clean up should include searching for references.

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

Modified: incubator/public/trunk/site-author/guides/mentor.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/mentor.xml?rev=639999&r1=639998&r2=639999&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/mentor.xml (original)
+++ incubator/public/trunk/site-author/guides/mentor.xml Sat Mar 22 07:05:35 2008
@@ -261,27 +261,75 @@
         In either case, the code to be imported should be attached to a JIRA 
         and then imported. It is recommended that the previous version 
         control system is tagged so that the imported version is precisely known.
+        </p><p>
+        A public record MUST be made of the code imported. If the import is not
+        attached to JIRA then it MUST be committed to version control.
         </p>
       </section>
       <section id='initial-clean-up'><title>Initial Clean Up</title>
         <p>
-        Once a JIRA has been created, the source need to be cleaned up. 
-        This includes:
+        Once a JIRA has been created, the source should be cleaned up. 
+        </p><p>
           <ul>
           <li>Ensure source files use the standard Apache boilerplates. This may mean
           replacing existing license headers. The tools in
           <code>https://svn.apache.org/repos/private/committers/tools</code>
-          and <code>https://svn.apache.org/repos/private/committers/tools</code>
+          and <code>https://svn.apache.org/repos/private/committers/relicense</code>
           may be useful.
           </li>
-          <li>Ensuring that NOTICE and LICENSE documents are present and correct</li>
+          <li>Ensure that NOTICE and LICENSE documents are present and correct</li>
           <li>Add any required notices. Consider moving copyright attributions 
-          from source documents to the NOTICE (see TODO)</li>
-          <li>Auditing the source for any potential licensing issues. Any which are
found 
+          from source documents to the NOTICE. Read 
+          <a href='http://www.apache.org/legal/src-headers.html'>Apache policy on headers</a>.</li>
+          <li>Audit the source for any potential licensing issues. Any which are found

           should either resolved immediately (when required) or noted in the status
           document for later.</li>
           </ul>
+        </p><p>
+        It is recommended that the initial clean up be is started before the code is committed.
+        It MUST be completed before any releases are cut.
         </p>
+      </section>
+      <section id='documents-clean-up'><title>Update Documents</title>
+        <p>
+        Check the documentation for references to the old home of the project and update
them 
+        with references to Apache. 
+        </p><p>
+        Read 
+        <a href='http://incubator.apache.org/guides/branding.html'>Branding Guide</a>.
+        Ensure that appropriate disclaimers are added to the appropriate documentation.
+        Consider adding a <code>DISCLAIMER</code> text document.
+        </p>
+        <section id='build-clean-up'><title>Update Build</title>
+        <p>
+        If the project uses <a href='http://maven.apache.org'>Apache Maven</a>,
the pom will
+        need to be updated to reflect that the project is now at Apache. In particular:
+        </p>
+        <ul>
+          <li>Update <code>mailingLists</code></li>
+          <li>Update <code>organization</code></li>
+          <li>Update <code>url</code></li>
+          <li>Update <code>issueManagement</code></li>
+          <li>Check <code>licenses</code></li>
+          <li>Update <code>scm</code></li>
+          <li>Update <code>groupId</code></li>
+          <li>Update <code>manifestEntries</code>. It is recommended that
the 
+          standard Apache settings are used</li>
+          <li>Update <code>developers</code> to use apache IDs (when known)</li>
+          <li>Update <code>distributionManagement</code></li>
+          <li>Consider specifying a <a href='http://maven.apache.org/pom.html#relocation'>relocation</a></li>
+        </ul>
+        <p>
+        If the project uses <a href='http://ant.apache.org'>Apache Ant</a>, the
build script
+        will probably need to be updated. In particular:
+        </p>
+        <ul>
+          <li>Ensure any MANIFESTs generated refer to Apache. It is recommended that
the
+          standard Apache settings are used.</li>
+          <li>Check that <code>LICENSE</code>, <code>NOTICE</code>
and - if appropriate - 
+          <code>DISCLAIMER</code> documents are copied into binary artifacts</li>
+        </ul>
+        </section>
       </section>
     </section>
     

Modified: incubator/public/trunk/site-publish/guides/mentor.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/mentor.html?rev=639999&r1=639998&r2=639999&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/mentor.html (original)
+++ incubator/public/trunk/site-publish/guides/mentor.html Sat Mar 22 07:05:35 2008
@@ -186,6 +186,16 @@
 Initial Clean Up
  </a>
 </li>
+<li><a href='#documents-clean-up'>
+Update Documents
+ </a>
+ <ul>
+<li><a href='#build-clean-up'>
+Update Build
+ </a>
+</li>
+</ul>
+</li>
 </ul>
 </li>
 <li><a href='#request-required-resources'>
@@ -501,27 +511,87 @@
         and then imported. It is recommended that the previous version 
         control system is tagged so that the imported version is precisely known.
         </p>
+<p>
+        A public record MUST be made of the code imported. If the import is not
+        attached to JIRA then it MUST be committed to version control.
+        </p>
 </div>
 <h4>
    <a name="initial-clean-up">Initial Clean Up</a>
 </h4>
 <div class="section-content">
 <p>
-        Once a JIRA has been created, the source need to be cleaned up. 
-        This includes:
+        Once a JIRA has been created, the source should be cleaned up. 
+        </p>
+<p>
           <ul>
           <li>Ensure source files use the standard Apache boilerplates. This may mean
-          replacing existing license headers. Useful tools are contained in
-          <code>https://svn.apache.org/repos/private/committers/tools</code>.
+          replacing existing license headers. The tools in
+          <code>https://svn.apache.org/repos/private/committers/tools</code>
+          and <code>https://svn.apache.org/repos/private/committers/relicense</code>
+          may be useful.
           </li>
-          <li>Ensuring that NOTICE and LICENSE documents are present and correct</li>
+          <li>Ensure that NOTICE and LICENSE documents are present and correct</li>
           <li>Add any required notices. Consider moving copyright attributions 
-          from source documents to the NOTICE (see TODO)</li>
-          <li>Auditing the source for any potential licensing issues. Any which are
found 
+          from source documents to the NOTICE. Read 
+          <a href="http://www.apache.org/legal/src-headers.html">Apache policy on headers</a>.</li>
+          <li>Audit the source for any potential licensing issues. Any which are found

           should either resolved immediately (when required) or noted in the status
           document for later.</li>
           </ul>
         </p>
+<p>
+        It is recommended that the initial clean up be is started before the code is committed.
+        It MUST be completed before any releases are cut.
+        </p>
+</div>
+<h4>
+   <a name="documents-clean-up">Update Documents</a>
+</h4>
+<div class="section-content">
+<p>
+        Check the documentation for references to the old home of the project and update
them 
+        with references to Apache. 
+        </p>
+<p>
+        Read 
+        <a href="http://incubator.apache.org/guides/branding.html">Branding Guide</a>.
+        Ensure that appropriate disclaimers are added to the appropriate documentation.
+        Consider adding a <code>DISCLAIMER</code> text document.
+        </p>
+<h5> 
+   <a name="build-clean-up">Update Build</a> 
+</h5> 
+<div class="section-content">
+<p>
+        If the project uses <a href="http://maven.apache.org">Apache Maven</a>,
the pom will
+        need to be updated to reflect that the project is now at Apache. In particular:
+        </p>
+<ul>
+          <li>Update <code>mailingLists</code></li>
+          <li>Update <code>organization</code></li>
+          <li>Update <code>url</code></li>
+          <li>Update <code>issueManagement</code></li>
+          <li>Check <code>licenses</code></li>
+          <li>Update <code>scm</code></li>
+          <li>Update <code>groupId</code></li>
+          <li>Update <code>manifestEntries</code>. It is recommended that
the 
+          standard Apache settings are used</li>
+          <li>Update <code>developers</code> to use apache IDs (when known)</li>
+          <li>Update <code>distributionManagement</code></li>
+          <li>Consider specifying a <a href="http://maven.apache.org/pom.html#relocation">relocation</a></li>
+        </ul>
+<p>
+        If the project uses <a href="http://ant.apache.org">Apache Ant</a>, the
build script
+        will probably need to be updated. In particular:
+        </p>
+<ul>
+          <li>Ensure any MANIFESTs generated refer to Apache. It is recommended that
the
+          standard Apache settings are used.</li>
+          <li>Check that <code>LICENSE</code>, <code>NOTICE</code>
and - if appropriate - 
+          <code>DISCLAIMER</code> documents are copied into binary artifacts</li>
+        </ul>
+</div>
 </div>
 </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