accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [1/2] accumulo-website git commit: Updated release guide with changes to Accumulo documentation
Date Tue, 06 Jun 2017 21:29:07 GMT
Repository: accumulo-website
Updated Branches:
  refs/heads/asf-site f4cf7bfb1 -> a0a66d3ea
  refs/heads/master a4540ce7f -> 8d90110ea


Updated release guide with changes to Accumulo documentation


Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/8d90110e
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/8d90110e
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/8d90110e

Branch: refs/heads/master
Commit: 8d90110ea901eafb315c385ffa1262e9dc907d99
Parents: a4540ce
Author: Mike Walch <mwalch@apache.org>
Authored: Tue Jun 6 17:27:23 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Tue Jun 6 17:27:23 2017 -0400

----------------------------------------------------------------------
 contributor/making-release.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/8d90110e/contributor/making-release.md
----------------------------------------------------------------------
diff --git a/contributor/making-release.md b/contributor/making-release.md
index 41a3e85..1c49c7c 100644
--- a/contributor/making-release.md
+++ b/contributor/making-release.md
@@ -109,16 +109,38 @@ automatically.
 
 Fill out the [add release][addrelease] form to update the projects website.
 
-## Update the Website
+## Update the Accumulo project website
 
 After a successful vote, this website needs to be updated with the new artifacts.
 
-  * Copy Accumulo User Manual (HTML version exists in >=1.7.0)
   * Update downloads page
   * Create a post in `_posts/release/` containing release notes (ensure notes contain link
to JIRA changes for that version)
   * Remove previous bug-fix release (if applicable)
   * Update doap_Accumulo.rdf
 
+### Documentation
+
+**For 2.x minor releases,** follow the steps below:
+
+1. Create a new documentation collection for the new minor release (i.e `2.0`) using the
unreleased collection. Avoid using a dot `.` in directory name:
+
+        cp -r _docs-unreleased _docs-2-0
+
+2. Create a new doc layout using the unreleased layout. Update the reference to `site.docs-unreleased`
to `site.docs-2-0` (if making 2.0 release):
+
+        cp _layouts/docs-unreleased.html _layouts/docs-2.0.html
+        vim _layouts/docs-2.0.html
+
+3. Point Jekyll to the new documentation collection by modifying `collections` and `defaults`
in `_config.yml`. Follow what was done for previous
+   releases.
+
+Once a collection is created for a 2.x minor release, developers can make documentation updates
like normal website updates.
+
+**For 2.x bugfix releases,** nothing needs to be done.
+
+**For 1.x minor & bugfix releases,** copy and commit the `accumulo_user_manual.html`
generated for release to the `1.x/` directory in
+Accumulo website repo.
+
 ### Javadocs
 
 Javadocs are easy to update. Using the latest JDK7 or later (at least JDK 7u21


Mime
View raw message