svn commit: r1575325 - /accumulo/site/trunk/content/releasing.mdtext

[el...@apache.org]

Author: elserj
Date: Fri Mar  7 17:05:41 2014
New Revision: 1575325

URL: http://svn.apache.org/r1575325
Log:
ACCUMULO-2394 Add section on how to update javadocs

Modified:
    accumulo/site/trunk/content/releasing.mdtext

Modified: accumulo/site/trunk/content/releasing.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/releasing.mdtext?rev=1575325&r1=1575324&r2=1575325&view=diff
==============================================================================
--- accumulo/site/trunk/content/releasing.mdtext (original)
+++ accumulo/site/trunk/content/releasing.mdtext Fri Mar  7 17:05:41 2014
@@ -95,9 +95,28 @@ out to all of the mirrors.
 
 After a successful vote, this website needs to be updated with the new artifacts. The downloads page should
 be updated with the new information. A new minor release should replace the previous minor release in the major
-version. The Javadocs should be updated, with special care being taken to ensure that Javadocs are [patched][7] **before**
+version. The user manual should also be updated if changes were made to it.
+
+### Javadocs
+
+Javadocs are a little convoluted to update. First off, be sure that the javadocs are [patched][7] **before**
 uploading as long as Java 6 is the version targeted by Accumulo (with greater than Java 7u21 being used once we
-switch to Java 7). The user manual should also be updated if changes were made to it.
+switch to Java 7). Despite the javadocs not appearing in the CMS SVN repository, this is
+where they need to be committed using [extpaths][8]. You can follow the steps below to update
+the javadocs.
+
+1. Extract javadocs from binary tarball from the release
+2. Run the vulnerability-check tool
+3. Checkout the [Accumulo CMS repository][9]
+4. Copy the entire apidocs folder in the appropriate version folder in the CMS repository (e.g. content/1.5/apidocs for a 1.5 release)
+5. Remove the appropriate entry from content/extpaths.txt (e.g. 1.5/apidocs for 1.5 release)
+6. Commit the changes
+7. Wait for the staging build to complete, and then publish the changes to the production site.
+8. Remove the apidocs folder you created from the CMS repository (e.g. content/1.5/apidocs)
+9. Re-add the entry in extpaths.txt that you previously removed.
+10. Commit the changes
+11. Wait for the staging build to complete, and then publish the changes to the production site again.
+12. Verify that javadocs have been updated on the production site
 
 ## References
 
@@ -109,10 +128,12 @@ Some good references that explain a few 
 - [Accumulo Release Guide][6]
 
 
-  [1]: https://www.apache.org/dev/release-signing
-  [2]: https://repository.apache.org/index.html
-  [3]: http://mail-archives.apache.org/mod_mbox/accumulo-dev/201305.mbox/raw/%3CCAL5zq9bH8y0FyjXmmfXhWPj8axosn9dZ7%2Bu-R1DK4Y-WM1YoWg%40mail.gmail.com%3E/
-  [4]: https://www.apache.org/dev/publishing-maven-artifacts.html
-  [5]: http://www.apache.org/dev/release-publishing.html
-  [6]: http://accumulo.apache.org/governance/releasing.html
-  [7]: http://www.kb.cert.org/vuls/id/225657
\ No newline at end of file
+[1]: https://www.apache.org/dev/release-signing
+[2]: https://repository.apache.org/index.html
+[3]: http://mail-archives.apache.org/mod_mbox/accumulo-dev/201305.mbox/raw/%3CCAL5zq9bH8y0FyjXmmfXhWPj8axosn9dZ7%2Bu-R1DK4Y-WM1YoWg%40mail.gmail.com%3E/
+[4]: https://www.apache.org/dev/publishing-maven-artifacts.html
+[5]: http://www.apache.org/dev/release-publishing.html
+[6]: http://accumulo.apache.org/governance/releasing.html
+[7]: http://www.kb.cert.org/vuls/id/225657
+[8]: http://www.apache.org/dev/cmsref#extpaths
+[9]: https://svn.apache.org/repos/asf/accumulo/site/trunk
\ No newline at end of file