accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [2/2] accumulo-website git commit: Jekyll build from master:8d90110
Date Tue, 06 Jun 2017 21:29:08 GMT
Jekyll build from master:8d90110

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/a0a66d3e
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/a0a66d3e
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/a0a66d3e

Branch: refs/heads/asf-site
Commit: a0a66d3ea1c6634fc6416400044f774471eedd2e
Parents: f4cf7bf
Author: Mike Walch <mwalch@apache.org>
Authored: Tue Jun 6 17:27:49 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Tue Jun 6 17:27:49 2017 -0400

----------------------------------------------------------------------
 contributor/making-release.html | 36 ++++++++++++++++++++++++++++++++++--
 feed.xml                        |  4 ++--
 2 files changed, 36 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a0a66d3e/contributor/making-release.html
----------------------------------------------------------------------
diff --git a/contributor/making-release.html b/contributor/making-release.html
index 787f443..6a24352 100644
--- a/contributor/making-release.html
+++ b/contributor/making-release.html
@@ -255,18 +255,50 @@ automatically.</p>
 
 <p>Fill out the <a href="https://reporter.apache.org/addrelease?accumulo">add
release</a> form to update the projects website.</p>
 
-<h2 id="update-the-website">Update the Website</h2>
+<h2 id="update-the-accumulo-project-website">Update the Accumulo project website</h2>
 
 <p>After a successful vote, this website needs to be updated with the new artifacts.</p>
 
 <ul>
-  <li>Copy Accumulo User Manual (HTML version exists in &gt;=1.7.0)</li>
   <li>Update downloads page</li>
   <li>Create a post in <code class="highlighter-rouge">_posts/release/</code>
containing release notes (ensure notes contain link to JIRA changes for that version)</li>
   <li>Remove previous bug-fix release (if applicable)</li>
   <li>Update doap_Accumulo.rdf</li>
 </ul>
 
+<h3 id="documentation">Documentation</h3>
+
+<p><strong>For 2.x minor releases,</strong> follow the steps below:</p>
+
+<ol>
+  <li>
+    <p>Create a new documentation collection for the new minor release (i.e <code
class="highlighter-rouge">2.0</code>) using the unreleased collection. Avoid using
a dot <code class="highlighter-rouge">.</code> in directory name:</p>
+
+    <div class="highlighter-rouge"><pre class="highlight"><code> cp -r
_docs-unreleased _docs-2-0
+</code></pre>
+    </div>
+  </li>
+  <li>
+    <p>Create a new doc layout using the unreleased layout. Update the reference to
<code class="highlighter-rouge">site.docs-unreleased</code> to <code class="highlighter-rouge">site.docs-2-0</code>
(if making 2.0 release):</p>
+
+    <div class="highlighter-rouge"><pre class="highlight"><code> cp _layouts/docs-unreleased.html
_layouts/docs-2.0.html
+ vim _layouts/docs-2.0.html
+</code></pre>
+    </div>
+  </li>
+  <li>
+    <p>Point Jekyll to the new documentation collection by modifying <code class="highlighter-rouge">collections</code>
and <code class="highlighter-rouge">defaults</code> in <code class="highlighter-rouge">_config.yml</code>.
Follow what was done for previous
+releases.</p>
+  </li>
+</ol>
+
+<p>Once a collection is created for a 2.x minor release, developers can make documentation
updates like normal website updates.</p>
+
+<p><strong>For 2.x bugfix releases,</strong> nothing needs to be done.</p>
+
+<p><strong>For 1.x minor &amp; bugfix releases,</strong> copy and commit
the <code class="highlighter-rouge">accumulo_user_manual.html</code> generated
for release to the <code class="highlighter-rouge">1.x/</code> directory in
+Accumulo website repo.</p>
+
 <h3 id="javadocs">Javadocs</h3>
 
 <p>Javadocs are easy to update. Using the latest JDK7 or later (at least JDK 7u21

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a0a66d3e/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index 898b9c3..ee22e5e 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 </description>
     <link>https://accumulo.apache.org/</link>
     <atom:link href="https://accumulo.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
-    <pubDate>Tue, 06 Jun 2017 16:12:23 -0400</pubDate>
-    <lastBuildDate>Tue, 06 Jun 2017 16:12:23 -0400</lastBuildDate>
+    <pubDate>Tue, 06 Jun 2017 17:27:41 -0400</pubDate>
+    <lastBuildDate>Tue, 06 Jun 2017 17:27:41 -0400</lastBuildDate>
     <generator>Jekyll v3.3.1</generator>
     
       <item>


Mime
View raw message