uima-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sc...@apache.org
Subject svn commit: r995574 - in /uima/site/trunk/uima-website: docs/ docs/board-reports/ docs/staging/ xdocs/ xdocs/staging/
Date Thu, 09 Sep 2010 20:52:30 GMT
Author: schor
Date: Thu Sep  9 20:52:30 2010
New Revision: 995574

URL: http://svn.apache.org/viewvc?rev=995574&view=rev
Log:
[UIMA-1857] [UIMA-1862] update docs, incl. removing one-time-setup for docbkx no longer needed.

Added:
    uima/site/trunk/uima-website/docs/board-reports/2010-09.txt
    uima/site/trunk/uima-website/docs/staging/release.html
    uima/site/trunk/uima-website/xdocs/staging/release.xml
Removed:
    uima/site/trunk/uima-website/docs/staging/building-uima.html
Modified:
    uima/site/trunk/uima-website/docs/checklist-release.html
    uima/site/trunk/uima-website/docs/one-time-setup.html
    uima/site/trunk/uima-website/docs/release.html
    uima/site/trunk/uima-website/docs/staging/testing-builds.html
    uima/site/trunk/uima-website/xdocs/checklist-release.xml
    uima/site/trunk/uima-website/xdocs/one-time-setup.xml
    uima/site/trunk/uima-website/xdocs/release.xml
    uima/site/trunk/uima-website/xdocs/staging/testing-builds.xml

Added: uima/site/trunk/uima-website/docs/board-reports/2010-09.txt
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/board-reports/2010-09.txt?rev=995574&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/board-reports/2010-09.txt (added)
+++ uima/site/trunk/uima-website/docs/board-reports/2010-09.txt Thu Sep  9 20:52:30 2010
@@ -0,0 +1,43 @@
+Status report for the Apache UIMA Project
+
+Apache UIMA's mission: the creation and maintenance of open-source
+software related to the analysis of unstructured data, guided by the
+UIMA Oasis Standard.
+
+Releases:
+
+Maven Build tooling artifacts (e.g., parent POMs, maven helper plugins 
+and resources) that we will be using for our actual releases have 
+been released.  This was our first use of the Apache Nexus repository 
+and staging mechanism.  We expect a release of UIMA itself, shortly,
+using this new tooling.
+
+2010-1-26 2.3.0 (Incubator - last release) release of Java SDK, Annotator
+                add-on package, UIMA-AS (Async scaleout), and UIMA-CPP
+                (C++ enablement)
+
+Development:
+
+Some users complained about the difficulty in getting through the 
+one-time-setups needed to build.  Some of this is because we're a bit on
+the bleeding edge for maven build tooling; some of the difficulties are
+going away as bugs are fixed in the underlying build tooling.
+
+A small annoyance in how UIMA's "ResultSpecification" worked led to
+a careful examination of a multitude of "corner cases", and eventually,
+to a complete redo of this part of the code.
+
+Jira issues continue to come in and get worked on at a moderate rate, 
+including several in the UIMA-AS (Asynchronous Scaleout) area related
+to various error recovery scenarios, mostly.
+
+A Maven-Central-upload event on Sept. 7 that placed many partial entries 
+for Eclipse 3.6 artifacts (missing POMs and JARs) ended up breaking 
+our builds; this was reported to the maven-dev list, and it is being 
+looked into.  We worked around this issue by adding dependencies to 
+our already version-locked-down Eclipse artifacts, to lock down the 
+transitively depended-on Eclipse artifacts.
+
+Community: No changes
+
+Issues: No Board level issues at this time
\ No newline at end of file

Modified: uima/site/trunk/uima-website/docs/checklist-release.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/checklist-release.html?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/checklist-release.html (original)
+++ uima/site/trunk/uima-website/docs/checklist-release.html Thu Sep  9 20:52:30 2010
@@ -169,49 +169,58 @@
       </td></tr>
       <tr><td>
         <blockquote class="sectionBody">
-                                    <p>Do <a href="one-time-release-setup.html">one-time setup</a> required for releasing.</p>
-                                                <ol>
+                                    <ol>
+  <li>Do <a href="one-time-release-setup.html">one-time setup</a> required for releasing.</li>
   <li>Finish up any changes, close Jiras, assign Jiras to proper release(s).</li>
-  <li>(If remerging a branch:  Note- best to do these if possible at the root of aggregations, 
+  <!--li>(If remerging a branch:  Note- best to do these if possible at the root of aggregations, 
     outside of Eclipse, so svn "batching" can work - will be quite a bit fraster)
     <ol><li>update branch working copy to head</li>
-      <li>merge trunk head -&gt; working copy (fully recursive)</li>
+      <li>merge trunk head -> working copy (fully recursive)</li>
       <li>commit</li>
       <li>switch working copy to trunk (fully recursive)</li>
-      <li>merge reintegrate branch -&gt; trunk</li>
+      <li>merge reintegrate branch -> trunk</li>
       <li>commit</li>
       <li>(cleanup at end- delete the old branch)</li>
     </ol>
-  </li>
+  </li-->
   <p>More details on next steps are 
     <a href="http://maven.apache.org/developers/release/apache-release.html">here</a></p>
-  <li>Scan poms to be sure there are <b>no</b> unintentional -SNAPSHOTs</li>
-  <li>Do next steps in top release aggregate.
-    <ol>
-      <li><code>mvn release:prepare -DdryRun=true</code> and diff the resulting poms
-        to verify nothing unintentional is dropped</li>
-      <li><code>mvn release:clean</code> to restore projects</li>
-      <li><code>mvn deploy</code> to deploy snapshot</li>
-      <li><code>mvn release:clean release:prepare</code></li>
-      <li><code>mvn release:perform</code></li>      
-    </ol>
-  </li>
-  <li>Repeat above steps for all things being released in one go (not already in an aggregate).</li>
-  <li>login to <a href="https://repository.apache.org">https://repository.apache.org</a>
-    using your Apache LDAP credentials, find the staging artifact, and right click - "close" it
-    after all things that are being included in this release are present.</li>
-  <li>Send [VOTE] message to dev list</li>
-  <li>Post RESULT message, promote the release</li>
-  <li>After release appears on central,
-    <ol><li>update projects that used to depend on old (perhaps snapshot)
-    versions of the released artifact(s) to depend on the released versions</li>
-    <li>build/test these</li>
-    <li>commit</li>
-    <li>mvn deploy (the snapshots for the changed projects)</li>
-    </ol>
+  <ol>
+    <p>Release one or more artifacts into the Apache Nexus staging repository.
+      You can do multiple release:prepare/perform steps, with subsequent steps
+      depending on the previous artifacts in their "release" version.</p>
+    <li>Do next steps in top release artifact (simple module, or xxx-distr).
+      <ol>
+        <p>Release one or more artifacts into the staging repo, where the artifacts don't depend
+          on the released version of each other.</p>     
+        <li>Scan poms to be sure there are <b>no</b> unintentional -SNAPSHOTs</li>    
+        <li><code>mvn release:prepare -DdryRun=true</code> and diff the resulting poms
+          to verify nothing unintentional is dropped or updated incorrectly</li>
+        <li><code>mvn release:clean</code> to restore projects</li>
+        <li><code>mvn deploy</code> to deploy snapshot</li>
+        <li><code>mvn release:prepare</code>. Try to accept the default suggestions for names.</li>
+        <li><code>mvn release:perform</code></li>      
+      </ol>
     </li>
+    <li>Repeat above steps for all things being released in one go (not already in an aggregate).</li>
+    <li>login to <a href="https://repository.apache.org">https://repository.apache.org</a>
+      using your Apache LDAP credentials, find the staging artifact, and right click - "close" it
+      after all things that are being included in this release are present.</li>
+    <li>Update the trunk: for all references that should now refer to the staged release version
+    </li>
+    <li>build/test these</li>
+    <li>commit trunk</li>  
+  </ol>
+  <!--li>
+    Repeat above steps for all sets of dependent things where you need to update the dependencies to
+    depend on the release version of previous steps.  When you're done, you will have 1 or more
+    "closed" staging repositories, each having a unique URL.
+  </li-->
+  <li>Send [VOTE] message to dev list.  List the staging repository that testers
+    will need to add to their <code>settings.xml</code> files.</li>
+  <li>Post RESULT message, promote the release(s) from the staging repositories</li>
   <li>Update Jira version info to reflect the release status and date</li>
-  <li>Post an announce letter</li>
+  <li>After release appears on maven central, post an appropriate announce letter</li>
   <li>Add release to next Board report</li>
   <li>Celebrate :-)</li>
 </ol>

Modified: uima/site/trunk/uima-website/docs/one-time-setup.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/one-time-setup.html?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/one-time-setup.html (original)
+++ uima/site/trunk/uima-website/docs/one-time-setup.html Thu Sep  9 20:52:30 2010
@@ -176,7 +176,6 @@
       <li><a href="#svn-setup">SVN</a></li>
       <li><a href="#maven-setup">Maven</a></li>
       <li><a href="#eclipse-setup">Eclipse</a></li>
-      <li><a href="#docbkx-setup">Docbkx</a> - a Maven plugin for processing Docbook files</li>
     </ul>
   </p>
                             </blockquote>
@@ -225,7 +224,8 @@
       </td></tr>
       <tr><td>
         <blockquote class="sectionBody">
-                                    <p>Install Eclipse version 3.5.x  
+                                    <p class="note"><b>Note: </b>See below for an alternative one-time setup for Eclipse that works with Eclipse 3.6</p>
+                                                <p>Install Eclipse version 3.5.x  
     (these instructions tested with Eclipse 3.5.2).</p>
                                                 <p class="note"><big><b>Don't use Eclipse version 3.6.x (Helios);</b></big> 
     it has issues with the m2eclipse plugin 0.10.0, which
@@ -275,33 +275,21 @@
       </td></tr>
     </table>
                                         <div class="sectionTable">
-      <table class="sectionTable" id='docbkx-setup'>
+      <table class="sectionTable">
         <tr><td>
-        <a name="One time setup for using the Docbkx Maven plugin"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;One time setup for using the Docbkx Maven plugin</h1></a>
+        <a name="Alternate one-time-setup for Eclipse"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Alternate one-time-setup for Eclipse</h1></a>
       </td></tr>
       <tr><td>
         <blockquote class="sectionBody">
                                     <p>
-    A patch is needed to get get the Maven Docbkx plugin to work with Maven 3:
-    <ol><li>use m2Eclipse to checkout the <code>docbkx-maven-base</code> project from
-        <code>http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10</code></li>
-        <p>To do this, 
-        add an svn repository pointing to <code>http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10</code>, and 
-        then open this link and navigate to the <code>docbkx-maven-base</code> project.  Right click it and
-        do Check-out-as-Maven-project.
-        <p class="note">If you don't have the m2eclipse/SCM integration "extras" installed (see above) you won't have 
-          the menu pick to Check-out-as-Maven-project.  In this case, just check it out normally, 
-          then delete it from the workspace
-          (but not from the disk), and then import the disk copy as a Maven project using the Import - as-Maven-project menu.</p>
-        </p>
-        <li>Edit line 472 of <code>AbstractTransformerMojo.java</code>, where it says <code>...getResources("/catalog.xml")</code> and 
-          remove the <code>/</code> in front of <code>catalog.xml</code>.</li>
-        <li>do a<code> mvn install </code> in the docbkx-maven-base directory, to install the fix to your local repo.</li>
-      </ol>
-      <p>
-      If you're interested in knowing more about this bug, see 
-    <a class="external" rel="nofollow" target="_blank" href="http://code.google.com/p/docbkx-tools/issues/detail?id=52">http://code.google.com/p/docbkx-tools/issues/detail?id=52</a>.
-      </p>
+    This setup installs a later (SNAPSHOT) version of the m2eclipse plugin which fixes the errors mentioned above, and works with 
+    the 3.6 version of Eclipse (Helios).
+  </p>
+                                                <p>
+    Proceed as above, except for the install of the m2eclipse main plugin.  For that, use a snapshot version, for instance, from 
+    <a href="https://repository.sonatype.org/content/sites/forge-sites/m2e/0.11.1/N/">
+      https://repository.sonatype.org/content/sites/forge-sites/m2e/0.11.1/N/
+    </a> - these are the "Nightly builds" I think.  I've tried and had luck with 0.11.1.201009041932, for instance.
   </p>
                             </blockquote>
         </p>

Modified: uima/site/trunk/uima-website/docs/release.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/release.html?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/release.html (original)
+++ uima/site/trunk/uima-website/docs/release.html Thu Sep  9 20:52:30 2010
@@ -172,9 +172,6 @@
                                     <p class="note">These instructions are mostly for the 2.3.0 release.  They are changing for the 2.3.1 release, and
   this page will be updated soon to reflect that.</p>
                                                 <p>
-  <a href="checklist-release">Checklist - doing a release (post 2.3.0)</a>
-</p>
-                                                <p>
       <ul>
 		<li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
     <li><a href="#Preparing Jira for the Release">Preparing Jira for the Release</a></li>

Added: uima/site/trunk/uima-website/docs/staging/release.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/staging/release.html?rev=995574&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/staging/release.html (added)
+++ uima/site/trunk/uima-website/docs/staging/release.html Thu Sep  9 20:52:30 2010
@@ -0,0 +1,594 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+
+    <!-- ====================================================================== -->
+    <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+    <!-- ====================================================================== -->
+    <html>
+        <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+            <style type="text/css">@import "stylesheets/base.css";</style>
+                                          <meta name="author" value="UIMA Documentation Team">
+  <meta name="email" value="dev@uima.apache.org">
+                        
+            
+                        
+                        <title>Apache UIMA - Doing a UIMA Release</title>
+        </head>
+
+        <body>
+          <div class="topLogos">        
+            <table border="0" width="100%" cellspacing="0">
+                <!-- TOP IMAGE -->
+                <tr>
+                    <td align='LEFT'>
+                      <a href="index.html">
+                                    <img style="border: 1px solid black;" src="../images/UIMA_banner2tlp.png" alt="UIMA project logo" border="0"/>
+                            </a>
+                    </td>
+                    <td align='CENTER'>
+                          <div class="pageBanner">Doing a UIMA Release</div>
+                    </td>
+                    <td align='RIGHT'>
+                                  <a href="http://www.apache.org">
+        <img src="../images/asf-logo-on-white-small.png" alt="Apache UIMA" border="0"/>
+      </a>
+                          </td>
+                </tr>
+            </table>
+            <hr noshade="" size="1"/>
+            </div>
+            <table border="0" width="100%" cellspacing="4">
+              <tr>
+                <td align='RIGHT' colspan="2">
+                  <form method="get" action="http://www.google.com/search">
+                    Search the site
+                    <input type="text"   name="q" size="25" maxlength="255" value="" />
+                    <input type="hidden" name="sitesearch" value="http://uima.apache.org/" />
+                    <input name="Search" value="Search Site" type="submit"/>
+                  </form>
+                </td>
+              </tr>
+              <tr> <!-- LEFT SIDE NAVIGATION -->
+                <td width="20%" valign="top">
+
+
+
+
+
+
+                   <!-- regular menu -->
+                      <div class="navBar">
+                  <br/>
+            <div class="navBarItem">      <div class="navPartHeading">General</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../index.html">Home</a>
+                </div>
+                          <div class="navBarItem">      <a href="../downloads.cgi">Downloads</a>
+                </div>
+                          <div class="navBarItem">      <a href="../documentation.html">Documentation</a>
+                </div>
+                          <div class="navBarItem">      <a href="../news.html">News</a>
+                </div>
+                    <br style="line-height: .5em"/>
+                          <div class="navBarItem">      <a href="../mail-lists.html">Mailing Lists</a>
+                </div>
+                          <div class="navBarItem">      <a href="../mail-lists.html#Apache_UIMA_Forums">Forums</a>
+                    <a href="http://news.gmane.org/gmane.comp.apache.uima.general" target="_blank"><em> Users</em> <img src="images/offsitelink.png" /></a>
+                  <a href="http://news.gmane.org/gmane.comp.apache.uima.devel" target="_blank"><em>Dev</em> <img src="images/offsitelink.png" /></a>
+              </div>
+                    <br style="line-height: .5em"/>
+                          <div class="navBarItem">      <a href="http://issues.apache.org/jira/browse/uima" target="_blank">Issue tracker <img src="images/offsitelink.png"</a>
+                </div>
+                          <div class="navBarItem">      <a href="http://cwiki.apache.org/UIMA/" target="_blank">Wiki <img src="images/offsitelink.png"</a>
+                </div>
+            </div>
+                      <br/>
+            <div class="navBarItem">      <div class="navPartHeading">Components & Tools</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../annotators.html">Annotators</a>
+                </div>
+                          <div class="navBarItem">      <a href="../toolsServers.html">Tools & Servers</a>
+                </div>
+                          <div class="navBarItem">      <a href="../sandbox.html">Sandbox</a>
+                </div>
+                          <div class="navBarItem">      <a href="../external-resources.html">External Resources</a>
+                </div>
+            </div>
+                      <br/>
+            <div class="navBarItem">      <div class="navPartHeading">Community</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../get-involved.html">Get Involved</a>
+                </div>
+                          <div class="navBarItem">      <a href="../contribution-policy.html">Contribution Policies</a>
+                </div>
+                          <div class="navBarItem">      <a href="../faq.html">FAQ</a>
+                </div>
+                          <div class="navBarItem">      <a href="../project-guidelines.html">Project Guidelines</a>
+                </div>
+            </div>
+                      <br/>
+            <div class="navBarItem">      <div class="navPartHeading">Development</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../one-time-setup.html">One-time setups</a>
+                </div>
+                          <div class="navBarItem">      <a href="../svn.html">Source Code</a>
+                </div>
+                          <div class="navBarItem">      <a href="../maven-design.html">Maven Use</a>
+                </div>
+                          <div class="navBarItem">      <a href="../building-uima.html">Building from Source</a>
+                </div>
+                          <div class="navBarItem">      <a href="../distribution.html">Creating a Distribution</a>
+                </div>
+                          <div class="navBarItem">      <a href="../release.html">Doing a UIMA release</a>
+                </div>
+                          <div class="navBarItem">      <a href="../codeConventions.html">Code Conventions</a>
+                </div>
+                          <div class="navBarItem">      <a href="../uima-specification.html">UIMA Specification (OASIS)</a>
+                </div>
+                          <div class="navBarItem">      <a href="../team-list.html">Project Team</a>
+                </div>
+            </div>
+                      <br/>
+            <div class="navBarItem">      <div class="navPartHeading">Events and Conferences</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../iks09.html">IKS 2009</a>
+                </div>
+                          <div class="navBarItem">      <a href="../gscl09.html">GSCL 2009</a>
+                </div>
+                          <div class="navBarItem">      <a href="../lsm09.html">LSM 2009</a>
+                </div>
+                          <div class="navBarItem">      <a href="../lrec08.html">LREC 2008</a>
+                </div>
+                          <div class="navBarItem">      <a href="../gldv07.html">GLDV 2007</a>
+                </div>
+            </div>
+                      <br/>
+            <div class="navBarItem">      <div class="navPartHeading">ASF</div>
+                </div>
+                <div class="navBar">
+                  <div class="navBarItem">      <a href="../license.html">License</a>
+                </div>
+                          <div class="navBarItem">      <a href="http://apache.org/foundataion/thanks.html" target="_blank">ASF Sponsors <img src="images/offsitelink.png"</a>
+                </div>
+                          <div class="navBarItem">      <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">ASF Sponsorship <img src="images/offsitelink.png"</a>
+                </div>
+            </div>
+        </div>
+                </td>
+                <td width="80%" align="left" valign="top">
+                                                          <div class="sectionTable">
+      <table class="sectionTable">
+        <tr><td>
+        <a name="Doing a UIMA Release"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/>&nbsp;Doing a UIMA Release</h1></a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="sectionBody">
+                                    <p class="note">These instructions are for the 2.3.1 and later releases, as a top level project.
+</p>
+                                                <p>Once you've done it a few times, you may find the shorter
+  <a href="checklist-release.html">release checklist</a> more convenient.
+</p>
+                                                <p>
+  <ul>
+    <li><a href="#Overview">Overview of releasing</a></li>
+		<li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
+    <li><a href="#Preparing Jira for the Release">Preparing Jira for the Release</a></li>
+		<li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+		<li><a href="#Building The Release Candidate">Building The Release Candidate</a></li>
+		<li><a href="#Doing The Release Vote">Doing The Release Vote</a></li>
+    <li><a href="#Ask Incubator PMC To Release">Ask Incubator PMC To Release</a></li>
+    <li><a href="#Publish The Release">Publish The Release</a></li>
+    <li><a href="#Announce The Release">Announce The Release</a></li>     
+      </ul>
+</p>
+                                                <br />
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Release Overview">
+            <h2>Release Overview
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+    The UIMA project mainly releases:
+    <ul><li>The UIMA SDK</li>
+      <li>UIMA-AS add-on</li>
+      <li>Individual Annotators, tooling, and other useful components (like the Simple Server)</li></ul>
+    In addition, it releases some Maven build tooling components that 
+    need to be in the Maven repositories to support our Maven processes.
+    </p>
+                                                <p>
+      Releases show up in the Maven central repository and/or 
+      as downloadable artifacts listed on our downloads pages.
+    </p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Release Discussions - Release Plan">
+            <h2>Release Discussions - Release Plan
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+		  At the beginning of the "UIMA Release Process" there must be consensus in the developer community 
+		  about the JIRA issues that should be part of the next release and the time frame for the release. 
+		  The result of this discussion should be published in a release plan to the UIMA wiki, if it is
+      complex. 
+		  This release plan should be kept up-to-date any time so that everybody can have a look at the target dates 
+		  to calculate personal ToDos.
+		</p>
+                                                <p>  
+		  The previous UIMA release plans and a release plan template are available in the UIMA wiki at
+		  <a href="http://cwiki.apache.org/UIMA/release-plan.html">http://cwiki.apache.org/UIMA/release-plan.html</a>
+		</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Preparing the Jira for the Release">
+            <h2>Preparing the Jira for the Release
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+      In a following step, you will extract from Jira the set of issues fixed in this release.
+      To make that work, go through the Jiras and insure the ones you are including in the release
+      are closed, and that the "Fixed in release xxx" is set for each Jira issue that is part of the
+      release.
+    </p>
+                                                <p>
+      There is a saved "filter" you can adjust for this that will display all fixed Jira issues with no Fixed in release xxx
+      assigned.  You can go through subsets of this (use the filter to pick the subset you want)
+      and do "bulk Jira changes" to update multiples of these in parallel, if that makes sense.
+    </p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Preparing The Sourcecode For The Release">
+            <h2>Preparing The Sourcecode For The Release
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+		  Before the source code can be tagged for the release check the points in the list below:
+		</p>
+                                                <p>
+		  <ul>
+        <li>Investigate versions of things using <br /><br />
+          <code>mvn versions:display-dependency-updates<br />
+          mvn versions:display-plugin-updates and<br />
+          mvn versions:display-property-updates</code><br /><br />
+          Use this information to update to later versions, if appropriate.</li>
+		    <li>
+		      Make sure that each release artifact that should be released has the correct version number.
+          These are normally updated automatically when the previous release is done.
+          <!--
+          There is an ant build script you can run here: <code>uimaj-distr/src/main/build/changeVersion.xml</code>.
+          To run it, first edit the file versions.properties in the same ... / build directory, setting 
+          the "previous" version (the current version info in the source), and the "new" version that it 
+          should be set to.  Then, <code>cd</code>
+          to <code>uimaj-distr/src/main/build</code> and do <code>ant changeVersion.xml</code> to run it. 
+          It checks the following places for correct versions.
+		      <ul>
+			      <li>uimaj project: POM.xml</li>
+			      <li>uimaj child projects: check version for the parent POM</li>
+			      <li>uimaj plugin projects (uimaj-ep-...): MANIFEST.MF</li>
+			      <li>uimaj-core project: UIMAFramework_impl.java</li>
+			      <li>uimaj-dist project: ReleaseNotes and Readme files</li>
+			      <li>uima-docbooks project: common_book_info.xml and index.html</li>
+            <li>uimaj Eclipse features</li>
+			  </ul>
+          Some of these things it doesn't update (if the update is complicated); in these case, 
+          it will instead, issue a reminder message to you
+          to update things manually. -->
+		    </li>
+		    <li>
+		      Make sure that any README files have been updated with the latest release information 
+          and release numbers.
+		    </li>
+		    <li>
+		      Update both versions (text and HTML) of the release notes for the release. JIRA can provide a list of 
+		      issues for a certain release when using the 'ReleaseNotes' function, 
+          after you've closed the Jira issues to be released with this version.
+		    </li>
+        <li>
+          Do a trial build of the release candidate:
+            cd **directory for building the components**  e.g. aggregate-uimaj
+            mvn install
+            cd **directory for creating the distribution** e.g. uimaj-distr
+            mvn install
+        </li>
+		  </ul>
+		</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Building The Release">
+            <h2>Building The Release
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p class="note">Prior to releasing, you must do the 
+      <a href="one-time-release-setup.html">one-time setup</a>
+      required for releasing
+    </p>
+                                                <p>
+      We use the maven-release-plugin to do the releasing.  In the prepare phase, it updates the
+      trunk artifacts to remove the -SNAPSHOT suffix, commits it to trunk, and then does an
+      SVN copy of the trunk to create the tag.  Then it updates the trunk artifacts to the next
+      version-SNAPSHOT, and commits that.
+    </p>
+                                                <p>The release:perform checks out the tag and builds/tests/installs and deploys it to the 
+      NEXUS staging repository.
+    </p>
+                                                <p>During this process, the release plugin asks what the next levels should be and what the tag name 
+        should be, and unless there's a good reason, we take the defaults (by just hitting enter).
+    </p>
+                                                <p>The release plugin automatically signs everything that needs signing using gpg.  It also
+      builds the sources.jar, and the source-release.zip file, which can be later obtained and 
+      should be a copy of the SVN tag for that artifact, and once unzipped, should be buildable,
+      using <code>mvn install</code>.
+    </p>
+                                                <p>You can upload to the Nexus Staging repository several independent artifacts; they will
+        all get added to the same unique temporary staging repository Nexus creates.  Once all the
+        artifacts are in place, you log into 
+        <a target="_blank" href="https://repository.apache.org">https://repository.apache.org</a> using your 
+          LDAP credentials, go to your staging repository, and "close" the repository.  After that,
+          nothing more can be added.  If you deploy another artifact, it will create a new 
+          staging repository.</p>
+                                                <p>If you have several artifacts to release, and you want subsequent artifacts to 
+        depend on the released versions of earlier ones, you can do this, by releasing the 
+        first one, then releasing subsequent ones that depend on that, etc.  This works because
+        the first one you release will get built with the release version and installed to your
+        local repository, as well as the Nexus staging repository.  So subsequent ones that depend on
+        the release version of previous ones, will find that in your local repository.  
+        </p>
+                                                <p>
+          If you forget something and close the staging repository too soon, just continue as if you hadn't.
+          Subsequent release artifacts will go into another newly created staging spot on Nexus.
+        </p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Removing -SNAPSHOT dependencies">
+            <h2>Removing -SNAPSHOT dependencies
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+      The release artifacts can refer to other artifacts in several ways, for example via the &lt;parent-pom&gt;
+      element, or via a &lt;dependency&gt; element.  Except for the docbook olink artifact, which is not released,
+      these dependencies should refer to non-snapshot versions of things.
+    </p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Doing The Release Vote">
+            <h2>Doing The Release Vote
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+      After things are staged, you write a note to the dev list, asking for an approval vote.
+      You need to provide the url(s) of the closed staging repository in the note so the approvers
+      can find the code to check.  The [VOTE] email should be based on similar previous votes, and
+      include instructions to testers on how to set up their maven settings.xml file to specify
+      the particular staging repository (or repositories, if more than one is being used).
+      For an example, see <a href="http://markmail.org/message/4ae7zb4ucmivlkaa">this dev-list post</a>.
+      
+		</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Releasing build tooling">
+            <h2>Releasing build tooling
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+      Build tooling is released, project by project - each component in the build has its
+      own release version number, numbered sequentially starting with 1, as is the convention
+      in other Apache projects for build tooling.
+    </p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Releasing">
+            <h2>Releasing
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+		  After a successful release vote for the release on the dev mailing list log on to the 
+      staging repository again, and release the staged artifacts.  This will make the artifacts
+      available in the Maven Central repository.
+		</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Publish The Release">
+            <h2>Publish The Release
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <ul>
+      <li>Build the Eclipse update site:
+      <ul>
+        <li>Edit the site.xml to include any new features.</li>
+        
+        <li>Copy from the approved release candidate any new feature Jars to the <code>features</code> directory.</li>
+        
+        <li>Copy from the approved release candidate any new plugin Jars to the <code>plugins</code> directory, after
+        first deleting any Jars that might be there from previous releases.</li>
+        
+        <li>run the ant build script to pack the new plugin Jars, and generate the new site digest containing
+        the new features.</li>
+        
+        <li>run the signEclipseUpdateSite.sh script to sign the new Jars and zip files the build script created.
+        This script can be run on linux or on windows, but on windows, you need to run it inside Cygwin.  When you install
+        Cygwin, indicate that it should fixup the windows line ending characters; otherwise the script may not run.</li>
+        
+        <li>Test the result: try using the new site (as a local site) in various versions of Eclipse, and verify it installs OK.
+        If there are errors, correct these and rebuild.</li>
+        
+        <li>SVN commit any changes you did to the trunk.  In particular, the uimaj-eclipse-update-site project's <code>features</code>
+        directory, containing any new Feature Jars, is committed, so future site builds have access to this information.
+        The <code>plugins</code> directory content is <b>not</b> committed, because the site build process does not 
+        require the plugin information.</li>
+        
+      </ul>
+      </li>
+      
+		<li><p>Upload the release artifacts to the distribution server (via uploading to people.apache.org
+      in the directory: <code>/www/www.apache.org/dist/uima</code>, including the 
+			release artifacts and the Eclipse update site data.  Be sure to include the gpg/md5/sha1 signatures.
+      Make sure the KEYS file in that uploaded directory is current. Additionally it is necessary to update
+      the download page of the UIMA website to make the new release artifacts available. </p>
+      <ul>
+        <li>The Eclipse update site on w.a.o/dist/uima will have previous versions of the jars for the
+        features and plugins.  The generated site in 
+          <code>uimaj-eclipse-update-site/target/eclipse-update-site</code> has the new version plugin(s)
+          and feature jars.  These should be added to the w.a.o/dist/uima update site - leave the others
+          that are already there in place.  The other non-jar files should be updated from the generated site.
+        </li>
+      </ul>
+    </li>
+      
+		<li><p>Update the documentation page with the new data on the UIMA website.  The mirroring stuff is
+    embedded in the markup - just substitute within that markup the name of the new release
+    (assuming you followed the previous release's naming conventions for the higher-level
+    directories).</p></li>
+            
+ 	</ul>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
+          <a name="Announce The Release">
+            <h2>Announce The Release
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>
+	    To announce the published release send and email to
+    </p>
+                                                <ul>
+	      <li>announce@apache.org</li>
+	      <li>user@uima.apache.org</li>
+	    </ul>
+                                                <p>
+	    and describe the major changes of the release. 
+	    Announcements should be posted from the release manager's <code>apache.org</code> address,
+      and signed by the release manager using the same code-signing key as was used to sign the release.
+	    For more details please refer to <a href="http://incubator.apache.org/guides/releasemanagement.html#announcements">
+	    A Guide To Release Management During Incubation</a>.
+	  </p>
+                                                <p>Our main uima website has a "News" section that should be updated with news of the release.</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                            </blockquote>
+        </p>
+      </td></tr>
+    </table>
+                                  </td>
+                </tr>
+                <!-- FOOTER -->
+                <tr><td colspan="2">
+                  <hr noshade="" size="1"/>
+                </td></tr>
+                <tr><td colspan="2"> 
+                  <table class="pageFooter">
+                    <tr>
+                      <td><a href="index.html">Home</a></td>
+                      <td><a href="privacy-policy.html">Privacy Policy</a></td>
+                      <td>
+                Copyright &#169; 2006-2009, The Apache Software Foundation
+                      </td>
+                      <td><a href="mailto:dev@uima.apache.org">Contact us</a></td>
+                    </tr>
+                  </table>                    
+                </td></tr>
+            </table>
+        </body>
+    </html>
+

Modified: uima/site/trunk/uima-website/docs/staging/testing-builds.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/staging/testing-builds.html?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/staging/testing-builds.html (original)
+++ uima/site/trunk/uima-website/docs/staging/testing-builds.html Thu Sep  9 20:52:30 2010
@@ -171,9 +171,7 @@
       <tr><td>
         <blockquote class="sectionBody">
                                     <ol>
-  <li>Set up Eclipse (optional):
-    <ol><li>add m2Eclipse and the patch (see svn.html) and subversion</li></ol>
-  </li>
+  <li>Do the normal <a href="one-time-setup.html">one-time-setup</a> if you haven't already done this.</li>
   <li>Set up your maven "settings.xml" file (located in the directory containing your local repository;
     in windows, this is in c:Documents and Settings\<your-userid>\.m2</your-userid>. Here's a sample:
 <pre>
@@ -195,20 +193,12 @@
   &lt;/profiles&gt;
 
 &lt;/settings&gt;
-</pre>   
+</pre>
+
+    <p class="note">
+      <b>Note:</b> The url element above is just a sample; each release will have its own unique staging repository name.
+    </p>   
   </li>
-  
-  <li>Fix the docbkx code: There's a one line fix needed, which hasn't been released (see 
-    <a class="external" rel="nofollow" target="_blank" href="http://code.google.com/p/docbkx-tools/issues/detail?id=52">http://code.google.com/p/docbkx-tools/issues/detail?id=52</a>.
-    <p>To fix, do the following:
-      <ol><li>use m2Eclipse to checkout 
-        http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10/docbkx-maven-base project</li>
-        <li>Edit line 472, where it says ...getResources("/catalog.xml") and remove the / in front of "catalog.xml".</li>
-        <li>do a "mvn install" to your local repo.</li>
-      </ol>
-        
-      </p>  
-    </li>
 </ol>
                             </blockquote>
         </p>
@@ -244,9 +234,10 @@
   mvn -Pstaged-release install 
 </pre></li>  
 </ol>
-                                                <p>If no errors, then conclude that the parent-pom-top is "good" and vote +1 :-) .</p>
                                                 <p class="note">Afterwards, go to your local repo and remove the org/apache/uima/parent-pom-top/1 directory,
-  to prevent it from accidentally being used, until it passes official release.</p>
+  to prevent it from accidentally being used, until it passes official release, unless this component
+  is needed (depended upon) by further artifacts in the group being released.
+</p>
                             </blockquote>
         </p>
       </td></tr>

Modified: uima/site/trunk/uima-website/xdocs/checklist-release.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/checklist-release.xml?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/checklist-release.xml (original)
+++ uima/site/trunk/uima-website/xdocs/checklist-release.xml Thu Sep  9 20:52:30 2010
@@ -28,10 +28,10 @@ under the License.
 
 <section name="Checklist: Release">
   
-<p>Do <a href="one-time-release-setup.html">one-time setup</a> required for releasing.</p>
 <ol>
+  <li>Do <a href="one-time-release-setup.html">one-time setup</a> required for releasing.</li>
   <li>Finish up any changes, close Jiras, assign Jiras to proper release(s).</li>
-  <li>(If remerging a branch:  Note- best to do these if possible at the root of aggregations, 
+  <!--li>(If remerging a branch:  Note- best to do these if possible at the root of aggregations, 
     outside of Eclipse, so svn "batching" can work - will be quite a bit fraster)
     <ol><li>update branch working copy to head</li>
       <li>merge trunk head -> working copy (fully recursive)</li>
@@ -41,36 +41,45 @@ under the License.
       <li>commit</li>
       <li>(cleanup at end- delete the old branch)</li>
     </ol>
-  </li>
+  </li-->
   <p>More details on next steps are 
     <a href="http://maven.apache.org/developers/release/apache-release.html">here</a></p>
-  <li>Scan poms to be sure there are <b>no</b> unintentional -SNAPSHOTs</li>
-  <li>Do next steps in top release aggregate.
-    <ol>
-      <li><code>mvn release:prepare -DdryRun=true</code> and diff the resulting poms
-        to verify nothing unintentional is dropped</li>
-      <li><code>mvn release:clean</code> to restore projects</li>
-      <li><code>mvn deploy</code> to deploy snapshot</li>
-      <li><code>mvn release:clean release:prepare</code></li>
-      <li><code>mvn release:perform</code></li>      
-    </ol>
-  </li>
-  <li>Repeat above steps for all things being released in one go (not already in an aggregate).</li>
-  <li>login to <a href="https://repository.apache.org">https://repository.apache.org</a>
-    using your Apache LDAP credentials, find the staging artifact, and right click - "close" it
-    after all things that are being included in this release are present.</li>
-  <li>Send [VOTE] message to dev list</li>
-  <li>Post RESULT message, promote the release</li>
-  <li>After release appears on central,
-    <ol><li>update projects that used to depend on old (perhaps snapshot)
-    versions of the released artifact(s) to depend on the released versions</li>
-    <li>build/test these</li>
-    <li>commit</li>
-    <li>mvn deploy (the snapshots for the changed projects)</li>
-    </ol>
+  <ol>
+    <p>Release one or more artifacts into the Apache Nexus staging repository.
+      You can do multiple release:prepare/perform steps, with subsequent steps
+      depending on the previous artifacts in their "release" version.</p>
+    <li>Do next steps in top release artifact (simple module, or xxx-distr).
+      <ol>
+        <p>Release one or more artifacts into the staging repo, where the artifacts don't depend
+          on the released version of each other.</p>     
+        <li>Scan poms to be sure there are <b>no</b> unintentional -SNAPSHOTs</li>    
+        <li><code>mvn release:prepare -DdryRun=true</code> and diff the resulting poms
+          to verify nothing unintentional is dropped or updated incorrectly</li>
+        <li><code>mvn release:clean</code> to restore projects</li>
+        <li><code>mvn deploy</code> to deploy snapshot</li>
+        <li><code>mvn release:prepare</code>. Try to accept the default suggestions for names.</li>
+        <li><code>mvn release:perform</code></li>      
+      </ol>
     </li>
+    <li>Repeat above steps for all things being released in one go (not already in an aggregate).</li>
+    <li>login to <a href="https://repository.apache.org">https://repository.apache.org</a>
+      using your Apache LDAP credentials, find the staging artifact, and right click - "close" it
+      after all things that are being included in this release are present.</li>
+    <li>Update the trunk: for all references that should now refer to the staged release version
+    </li>
+    <li>build/test these</li>
+    <li>commit trunk</li>  
+  </ol>
+  <!--li>
+    Repeat above steps for all sets of dependent things where you need to update the dependencies to
+    depend on the release version of previous steps.  When you're done, you will have 1 or more
+    "closed" staging repositories, each having a unique URL.
+  </li-->
+  <li>Send [VOTE] message to dev list.  List the staging repository that testers
+    will need to add to their <code>settings.xml</code> files.</li>
+  <li>Post RESULT message, promote the release(s) from the staging repositories</li>
   <li>Update Jira version info to reflect the release status and date</li>
-  <li>Post an announce letter</li>
+  <li>After release appears on maven central, post an appropriate announce letter</li>
   <li>Add release to next Board report</li>
   <li>Celebrate :-)</li>
 </ol>

Modified: uima/site/trunk/uima-website/xdocs/one-time-setup.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/one-time-setup.xml?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/one-time-setup.xml (original)
+++ uima/site/trunk/uima-website/xdocs/one-time-setup.xml Thu Sep  9 20:52:30 2010
@@ -35,7 +35,6 @@ under the License.
       <li><a href="#svn-setup">SVN</a></li>
       <li><a href="#maven-setup">Maven</a></li>
       <li><a href="#eclipse-setup">Eclipse</a></li>
-      <li><a href="#docbkx-setup">Docbkx</a> - a Maven plugin for processing Docbook files</li>
     </ul>
   </p>
 </section>
@@ -63,6 +62,9 @@ under the License.
 </section>
 
 <section name="One time setup for Eclipse" id="eclipse-setup">
+  
+  <p class="note"><b>Note: </b>See below for an alternative one-time setup for Eclipse that works with Eclipse 3.6</p>
+  
   <p>Install Eclipse version 3.5.x  
     (these instructions tested with Eclipse 3.5.2).</p>
   <p class="note"><big><b>Don't use Eclipse version 3.6.x (Helios);</b></big> 
@@ -116,31 +118,18 @@ under the License.
   </p>
 </section>
 
-<section name="One time setup for using the Docbkx Maven plugin" id="docbkx-setup">
+<section name="Alternate one-time-setup for Eclipse">
   <p>
-    A patch is needed to get get the Maven Docbkx plugin to work with Maven 3:
-    <ol><li>use m2Eclipse to checkout the <code>docbkx-maven-base</code> project from
-        <code>http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10</code></li>
-        <p>To do this, 
-        add an svn repository pointing to <code>http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10</code>, and 
-        then open this link and navigate to the <code>docbkx-maven-base</code> project.  Right click it and
-        do Check-out-as-Maven-project.
-        <p class="note">If you don't have the m2eclipse/SCM integration "extras" installed (see above) you won't have 
-          the menu pick to Check-out-as-Maven-project.  In this case, just check it out normally, 
-          then delete it from the workspace
-          (but not from the disk), and then import the disk copy as a Maven project using the Import - as-Maven-project menu.</p>
-        </p>
-        <li>Edit line 472 of <code>AbstractTransformerMojo.java</code>, where it says <code>...getResources("/catalog.xml")</code> and 
-          remove the <code>/</code> in front of <code>catalog.xml</code>.</li>
-        <li>do a<code> mvn install </code> in the docbkx-maven-base directory, to install the fix to your local repo.</li>
-      </ol>
-      <p>
-      If you're interested in knowing more about this bug, see 
-    <a class="external" rel="nofollow" target="_blank"
-      href="http://code.google.com/p/docbkx-tools/issues/detail?id=52">http://code.google.com/p/docbkx-tools/issues/detail?id=52</a>.
-      </p>
+    This setup installs a later (SNAPSHOT) version of the m2eclipse plugin which fixes the errors mentioned above, and works with 
+    the 3.6 version of Eclipse (Helios).
   </p>
-
+  
+  <p>
+    Proceed as above, except for the install of the m2eclipse main plugin.  For that, use a snapshot version, for instance, from 
+    <a href="https://repository.sonatype.org/content/sites/forge-sites/m2e/0.11.1/N/">
+      https://repository.sonatype.org/content/sites/forge-sites/m2e/0.11.1/N/
+    </a> - these are the "Nightly builds" I think.  I've tried and had luck with 0.11.1.201009041932, for instance.
+  </p>
 </section>
 </body>
 </document>

Modified: uima/site/trunk/uima-website/xdocs/release.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/release.xml?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/release.xml (original)
+++ uima/site/trunk/uima-website/xdocs/release.xml Thu Sep  9 20:52:30 2010
@@ -30,10 +30,6 @@ under the License.
 
 <p class="note">These instructions are mostly for the 2.3.0 release.  They are changing for the 2.3.1 release, and
   this page will be updated soon to reflect that.</p>
-
-<p>
-  <a href="checklist-release">Checklist - doing a release (post 2.3.0)</a>
-</p>
   
 <p>
       <ul>

Added: uima/site/trunk/uima-website/xdocs/staging/release.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/staging/release.xml?rev=995574&view=auto
==============================================================================
--- uima/site/trunk/uima-website/xdocs/staging/release.xml (added)
+++ uima/site/trunk/uima-website/xdocs/staging/release.xml Thu Sep  9 20:52:30 2010
@@ -0,0 +1,314 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+ to you 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.
+-->
+<document>
+
+<properties>
+<title>Doing a UIMA Release</title>
+<author email="dev@uima.apache.org">UIMA Documentation Team</author>
+</properties>
+
+<body>
+
+<section name="Doing a UIMA Release">
+  
+<p class="note">These instructions are for the 2.3.1 and later releases, as a top level project.
+</p>  
+
+<p>Once you've done it a few times, you may find the shorter
+  <a href="checklist-release.html">release checklist</a> more convenient.
+</p>
+  
+<p>
+  <ul>
+    <li><a href="#Overview">Overview of releasing</a></li>
+		<li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
+    <li><a href="#Preparing Jira for the Release">Preparing Jira for the Release</a></li>
+		<li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+		<li><a href="#Building The Release Candidate">Building The Release Candidate</a></li>
+		<li><a href="#Doing The Release Vote">Doing The Release Vote</a></li>
+    <li><a href="#Ask Incubator PMC To Release">Ask Incubator PMC To Release</a></li>
+    <li><a href="#Publish The Release">Publish The Release</a></li>
+    <li><a href="#Announce The Release">Announce The Release</a></li>     
+      </ul>
+</p>
+
+<br></br>
+
+  <subsection name="Release Overview">
+    <p>
+    The UIMA project mainly releases:
+    <ul><li>The UIMA SDK</li>
+      <li>UIMA-AS add-on</li>
+      <li>Individual Annotators, tooling, and other useful components (like the Simple Server)</li></ul>
+    In addition, it releases some Maven build tooling components that 
+    need to be in the Maven repositories to support our Maven processes.
+    </p>
+    
+    <p>
+      Releases show up in the Maven central repository and/or 
+      as downloadable artifacts listed on our downloads pages.
+    </p>
+    
+  </subsection>
+
+	<subsection name='Release Discussions - Release Plan'>
+		<p>
+		  At the beginning of the "UIMA Release Process" there must be consensus in the developer community 
+		  about the JIRA issues that should be part of the next release and the time frame for the release. 
+		  The result of this discussion should be published in a release plan to the UIMA wiki, if it is
+      complex. 
+		  This release plan should be kept up-to-date any time so that everybody can have a look at the target dates 
+		  to calculate personal ToDos.
+		</p>
+		<p>  
+		  The previous UIMA release plans and a release plan template are available in the UIMA wiki at
+		  <a href="http://cwiki.apache.org/UIMA/release-plan.html">http://cwiki.apache.org/UIMA/release-plan.html</a>
+		</p> 
+	</subsection>
+	
+  <subsection name='Preparing the Jira for the Release'>
+    <p>
+      In a following step, you will extract from Jira the set of issues fixed in this release.
+      To make that work, go through the Jiras and insure the ones you are including in the release
+      are closed, and that the "Fixed in release xxx" is set for each Jira issue that is part of the
+      release.
+    </p>
+    
+    <p>
+      There is a saved "filter" you can adjust for this that will display all fixed Jira issues with no Fixed in release xxx
+      assigned.  You can go through subsets of this (use the filter to pick the subset you want)
+      and do "bulk Jira changes" to update multiples of these in parallel, if that makes sense.
+    </p>
+  </subsection>
+  
+	<subsection name='Preparing The Sourcecode For The Release'>
+		<p>
+		  Before the source code can be tagged for the release check the points in the list below:
+		</p>
+		<p>
+		  <ul>
+        <li>Investigate versions of things using <br/><br/>
+          <code>mvn versions:display-dependency-updates<br/>
+          mvn versions:display-plugin-updates and<br/>
+          mvn versions:display-property-updates</code><br/><br/>
+          Use this information to update to later versions, if appropriate.</li>
+		    <li>
+		      Make sure that each release artifact that should be released has the correct version number.
+          These are normally updated automatically when the previous release is done.
+          <!--
+          There is an ant build script you can run here: <code>uimaj-distr/src/main/build/changeVersion.xml</code>.
+          To run it, first edit the file versions.properties in the same ... / build directory, setting 
+          the "previous" version (the current version info in the source), and the "new" version that it 
+          should be set to.  Then, <code>cd</code>
+          to <code>uimaj-distr/src/main/build</code> and do <code>ant changeVersion.xml</code> to run it. 
+          It checks the following places for correct versions.
+		      <ul>
+			      <li>uimaj project: POM.xml</li>
+			      <li>uimaj child projects: check version for the parent POM</li>
+			      <li>uimaj plugin projects (uimaj-ep-...): MANIFEST.MF</li>
+			      <li>uimaj-core project: UIMAFramework_impl.java</li>
+			      <li>uimaj-dist project: ReleaseNotes and Readme files</li>
+			      <li>uima-docbooks project: common_book_info.xml and index.html</li>
+            <li>uimaj Eclipse features</li>
+			  </ul>
+          Some of these things it doesn't update (if the update is complicated); in these case, 
+          it will instead, issue a reminder message to you
+          to update things manually. -->
+		    </li>
+		    <li>
+		      Make sure that any README files have been updated with the latest release information 
+          and release numbers.
+		    </li>
+		    <li>
+		      Update both versions (text and HTML) of the release notes for the release. JIRA can provide a list of 
+		      issues for a certain release when using the 'ReleaseNotes' function, 
+          after you've closed the Jira issues to be released with this version.
+		    </li>
+        <li>
+          Do a trial build of the release candidate:
+            cd **directory for building the components**  e.g. aggregate-uimaj
+            mvn install
+            cd **directory for creating the distribution** e.g. uimaj-distr
+            mvn install
+        </li>
+		  </ul>
+		</p>
+	</subsection>
+	
+	<subsection name='Building The Release'>
+    <p class="note">Prior to releasing, you must do the 
+      <a href="one-time-release-setup.html">one-time setup</a>
+      required for releasing
+    </p>
+		<p>
+      We use the maven-release-plugin to do the releasing.  In the prepare phase, it updates the
+      trunk artifacts to remove the -SNAPSHOT suffix, commits it to trunk, and then does an
+      SVN copy of the trunk to create the tag.  Then it updates the trunk artifacts to the next
+      version-SNAPSHOT, and commits that.
+    </p>
+      
+    <p>The release:perform checks out the tag and builds/tests/installs and deploys it to the 
+      NEXUS staging repository.
+    </p>
+      
+    <p>During this process, the release plugin asks what the next levels should be and what the tag name 
+        should be, and unless there's a good reason, we take the defaults (by just hitting enter).
+    </p>
+    <p>The release plugin automatically signs everything that needs signing using gpg.  It also
+      builds the sources.jar, and the source-release.zip file, which can be later obtained and 
+      should be a copy of the SVN tag for that artifact, and once unzipped, should be buildable,
+      using <code>mvn install</code>.
+    </p> 
+      
+    <p>You can upload to the Nexus Staging repository several independent artifacts; they will
+        all get added to the same unique temporary staging repository Nexus creates.  Once all the
+        artifacts are in place, you log into 
+        <a target="_blank" 
+          href="https://repository.apache.org">https://repository.apache.org</a> using your 
+          LDAP credentials, go to your staging repository, and "close" the repository.  After that,
+          nothing more can be added.  If you deploy another artifact, it will create a new 
+          staging repository.</p>
+          
+    <p>If you have several artifacts to release, and you want subsequent artifacts to 
+        depend on the released versions of earlier ones, you can do this, by releasing the 
+        first one, then releasing subsequent ones that depend on that, etc.  This works because
+        the first one you release will get built with the release version and installed to your
+        local repository, as well as the Nexus staging repository.  So subsequent ones that depend on
+        the release version of previous ones, will find that in your local repository.  
+        </p>  
+        
+        <p>
+          If you forget something and close the staging repository too soon, just continue as if you hadn't.
+          Subsequent release artifacts will go into another newly created staging spot on Nexus.
+        </p>
+        
+	</subsection>
+	
+  <subsection name='Removing -SNAPSHOT dependencies'>
+    <p>
+      The release artifacts can refer to other artifacts in several ways, for example via the &lt;parent-pom>
+      element, or via a &lt;dependency> element.  Except for the docbook olink artifact, which is not released,
+      these dependencies should refer to non-snapshot versions of things.
+    </p>
+  </subsection>
+  
+	<subsection name='Doing The Release Vote'>
+		<p>
+      After things are staged, you write a note to the dev list, asking for an approval vote.
+      You need to provide the url(s) of the closed staging repository in the note so the approvers
+      can find the code to check.  The [VOTE] email should be based on similar previous votes, and
+      include instructions to testers on how to set up their maven settings.xml file to specify
+      the particular staging repository (or repositories, if more than one is being used).
+      For an example, see <a href="http://markmail.org/message/4ae7zb4ucmivlkaa">this dev-list post</a>.
+      
+		</p>
+	</subsection>
+  
+  <subsection name='Releasing build tooling'>
+    <p>
+      Build tooling is released, project by project - each component in the build has its
+      own release version number, numbered sequentially starting with 1, as is the convention
+      in other Apache projects for build tooling.
+    </p>    
+  </subsection>
+
+	<subsection name='Releasing'>
+		<p>
+		  After a successful release vote for the release on the dev mailing list log on to the 
+      staging repository again, and release the staged artifacts.  This will make the artifacts
+      available in the Maven Central repository.
+		</p>
+	</subsection>
+
+	<subsection name='Publish The Release'>
+
+		<ul>
+      <li>Build the Eclipse update site:
+      <ul>
+        <li>Edit the site.xml to include any new features.</li>
+        
+        <li>Copy from the approved release candidate any new feature Jars to the <code>features</code> directory.</li>
+        
+        <li>Copy from the approved release candidate any new plugin Jars to the <code>plugins</code> directory, after
+        first deleting any Jars that might be there from previous releases.</li>
+        
+        <li>run the ant build script to pack the new plugin Jars, and generate the new site digest containing
+        the new features.</li>
+        
+        <li>run the signEclipseUpdateSite.sh script to sign the new Jars and zip files the build script created.
+        This script can be run on linux or on windows, but on windows, you need to run it inside Cygwin.  When you install
+        Cygwin, indicate that it should fixup the windows line ending characters; otherwise the script may not run.</li>
+        
+        <li>Test the result: try using the new site (as a local site) in various versions of Eclipse, and verify it installs OK.
+        If there are errors, correct these and rebuild.</li>
+        
+        <li>SVN commit any changes you did to the trunk.  In particular, the uimaj-eclipse-update-site project's <code>features</code>
+        directory, containing any new Feature Jars, is committed, so future site builds have access to this information.
+        The <code>plugins</code> directory content is <b>not</b> committed, because the site build process does not 
+        require the plugin information.</li>
+        
+      </ul>
+      </li>
+      
+		<li><p>Upload the release artifacts to the distribution server (via uploading to people.apache.org
+      in the directory: <code>/www/www.apache.org/dist/uima</code>, including the 
+			release artifacts and the Eclipse update site data.  Be sure to include the gpg/md5/sha1 signatures.
+      Make sure the KEYS file in that uploaded directory is current. Additionally it is necessary to update
+      the download page of the UIMA website to make the new release artifacts available. </p>
+      <ul>
+        <li>The Eclipse update site on w.a.o/dist/uima will have previous versions of the jars for the
+        features and plugins.  The generated site in 
+          <code>uimaj-eclipse-update-site/target/eclipse-update-site</code> has the new version plugin(s)
+          and feature jars.  These should be added to the w.a.o/dist/uima update site - leave the others
+          that are already there in place.  The other non-jar files should be updated from the generated site.
+        </li>
+      </ul>
+    </li>
+      
+		<li><p>Update the documentation page with the new data on the UIMA website.  The mirroring stuff is
+    embedded in the markup - just substitute within that markup the name of the new release
+    (assuming you followed the previous release's naming conventions for the higher-level
+    directories).</p></li>
+            
+ 	</ul>
+	</subsection>
+	
+	<subsection name='Announce The Release'>
+	  <p>
+	    To announce the published release send and email to
+    </p>
+	    <ul>
+	      <li>announce@apache.org</li>
+	      <li>user@uima.apache.org</li>
+	    </ul>
+    <p>
+	    and describe the major changes of the release. 
+	    Announcements should be posted from the release manager's <code>apache.org</code> address,
+      and signed by the release manager using the same code-signing key as was used to sign the release.
+	    For more details please refer to <a href="http://incubator.apache.org/guides/releasemanagement.html#announcements">
+	    A Guide To Release Management During Incubation</a>.
+	  </p>
+    <p>Our main uima website has a "News" section that should be updated with news of the release.</p>
+	</subsection>
+
+</section>
+
+</body>
+</document>

Modified: uima/site/trunk/uima-website/xdocs/staging/testing-builds.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/staging/testing-builds.xml?rev=995574&r1=995573&r2=995574&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/staging/testing-builds.xml (original)
+++ uima/site/trunk/uima-website/xdocs/staging/testing-builds.xml Thu Sep  9 20:52:30 2010
@@ -30,9 +30,7 @@ under the License.
 
 <section name="Setup (one time) for building">
 <ol>
-  <li>Set up Eclipse (optional):
-    <ol><li>add m2Eclipse and the patch (see svn.html) and subversion</li></ol>
-  </li>
+  <li>Do the normal <a href="one-time-setup.html">one-time-setup</a> if you haven't already done this.</li>
   <li>Set up your maven "settings.xml" file (located in the directory containing your local repository;
     in windows, this is in c:Documents and Settings\<your-userid>\.m2</your-userid>. Here's a sample:
 <pre>
@@ -54,21 +52,12 @@ under the License.
   &lt;/profiles>
 
 &lt;/settings>
-</pre>   
+</pre>
+
+    <p class="note">
+      <b>Note:</b> The url element above is just a sample; each release will have its own unique staging repository name.
+    </p>   
   </li>
-  
-  <li>Fix the docbkx code: There's a one line fix needed, which hasn't been released (see 
-    <a class="external" rel="nofollow" target="_blank"
-      href="http://code.google.com/p/docbkx-tools/issues/detail?id=52">http://code.google.com/p/docbkx-tools/issues/detail?id=52</a>.
-    <p>To fix, do the following:
-      <ol><li>use m2Eclipse to checkout 
-        http://docbkx-tools.googlecode.com/svn/tags/docbkx-2.0.10/docbkx-maven-base project</li>
-        <li>Edit line 472, where it says ...getResources("/catalog.xml") and remove the / in front of "catalog.xml".</li>
-        <li>do a "mvn install" to your local repo.</li>
-      </ol>
-        
-      </p>  
-    </li>
 </ol>  
 </section>
 
@@ -98,10 +87,10 @@ under the License.
 </pre></li>  
 </ol>
 
-<p>If no errors, then conclude that the parent-pom-top is "good" and vote +1 :-) .</p>
-
 <p class="note">Afterwards, go to your local repo and remove the org/apache/uima/parent-pom-top/1 directory,
-  to prevent it from accidentally being used, until it passes official release.</p>
+  to prevent it from accidentally being used, until it passes official release, unless this component
+  is needed (depended upon) by further artifacts in the group being released.
+</p>
 
 </section>
 </body>



Mime
View raw message