You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mw...@apache.org on 2017/06/07 14:01:27 UTC
[1/2] accumulo-website git commit: Update release guide for
documentation
Repository: accumulo-website
Updated Branches:
refs/heads/asf-site a0a66d3ea -> 459ae60a2
refs/heads/master 8d90110ea -> 3afe129f3
Update release guide for 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/3afe129f
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/3afe129f
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/3afe129f
Branch: refs/heads/master
Commit: 3afe129f3b560793d06cf015bc0629b7a2874845
Parents: 8d90110
Author: Mike Walch <mw...@apache.org>
Authored: Wed Jun 7 09:58:06 2017 -0400
Committer: Mike Walch <mw...@apache.org>
Committed: Wed Jun 7 09:58:06 2017 -0400
----------------------------------------------------------------------
contributor/making-release.md | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/3afe129f/contributor/making-release.md
----------------------------------------------------------------------
diff --git a/contributor/making-release.md b/contributor/making-release.md
index 1c49c7c..9055976 100644
--- a/contributor/making-release.md
+++ b/contributor/making-release.md
@@ -111,7 +111,7 @@ Fill out the [add release][addrelease] form to update the projects website.
## Update the Accumulo project website
-After a successful vote, this website needs to be updated with the new artifacts.
+After a successful vote, [this website][website-repo] needs to be updated with the new artifacts.
* Update downloads page
* Create a post in `_posts/release/` containing release notes (ensure notes contain link to JIRA changes for that version)
@@ -120,9 +120,20 @@ After a successful vote, this website needs to be updated with the new artifacts
### Documentation
+Starting with 2.0.0, the source code for the Accumulo documentation was moved to the [accumulo-website repo][website-repo] except
+for two markdown files that should be changed in the Accumulo repo and copied/mirrored to the website repo for releases.
+
+1. `INSTALL.md` is mirrored from Accumulo repo using a tool like `meld`.
+
+ meld /path/to/accumulo/INSTALL.md /path/to/accumulo-website/_docs-2-x/getting-started/quick-install.md
+
+2. `configuration-properties` is copied after it is generated by the Accumulo build.
+
+ cp /path/to/accumulo/core/target/generated-docs/configuration-properties.md /path/to/accumulo-website/_docs-2-x/administration/configuration-properties.md
+
**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:
+1. Create a new documentation collection for the new minor release (i.e `2.0`) using the unreleased collection. Avoid using a dot `.` in the directory name:
cp -r _docs-unreleased _docs-2-0
@@ -134,12 +145,13 @@ After a successful vote, this website needs to be updated with the new artifacts
3. Point Jekyll to the new documentation collection by modifying `collections` and `defaults` in `_config.yml`. Follow what was done for previous
releases.
+4. Copy `configuration-properties` and mirror `INSTALL.md`.
+
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 2.x bugfix releases,** copy `configuration-properties` and mirror `INSTALL.md`.
-**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.
+**For 1.x minor & bugfix releases,** copy `accumulo_user_manual.html` generated for release to the `1.x/` directory in the [accumulo-website repo][website-repo].
### Javadocs
@@ -185,3 +197,4 @@ Some good references that explain a few things:
[addrelease]: https://reporter.apache.org/addrelease?accumulo
[verify]: {{ "/contributor/verifying-release" | relative_url }}
[examples]: https://github.com/apache/accumulo-examples
+[website-repo]: https://github.com/apache/accumulo-website
[2/2] accumulo-website git commit: Jekyll build from master:3afe129
Posted by mw...@apache.org.
Jekyll build from master:3afe129
Update release guide for 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/459ae60a
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/459ae60a
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/459ae60a
Branch: refs/heads/asf-site
Commit: 459ae60a2f00c8941b9c58012b9ea844fa82022b
Parents: a0a66d3
Author: Mike Walch <mw...@apache.org>
Authored: Wed Jun 7 09:58:47 2017 -0400
Committer: Mike Walch <mw...@apache.org>
Committed: Wed Jun 7 09:58:47 2017 -0400
----------------------------------------------------------------------
contributor/making-release.html | 32 +++++++++++++++++++++++++++-----
feed.xml | 4 ++--
2 files changed, 29 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/459ae60a/contributor/making-release.html
----------------------------------------------------------------------
diff --git a/contributor/making-release.html b/contributor/making-release.html
index 6a24352..88f696f 100644
--- a/contributor/making-release.html
+++ b/contributor/making-release.html
@@ -257,7 +257,7 @@ automatically.</p>
<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>
+<p>After a successful vote, <a href="https://github.com/apache/accumulo-website">this website</a> needs to be updated with the new artifacts.</p>
<ul>
<li>Update downloads page</li>
@@ -268,11 +268,31 @@ automatically.</p>
<h3 id="documentation">Documentation</h3>
+<p>Starting with 2.0.0, the source code for the Accumulo documentation was moved to the <a href="https://github.com/apache/accumulo-website">accumulo-website repo</a> except
+for two markdown files that should be changed in the Accumulo repo and copied/mirrored to the website repo for releases.</p>
+
+<ol>
+ <li>
+ <p><code class="highlighter-rouge">INSTALL.md</code> is mirrored from Accumulo repo using a tool like <code class="highlighter-rouge">meld</code>.</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> meld /path/to/accumulo/INSTALL.md /path/to/accumulo-website/_docs-2-x/getting-started/quick-install.md
+</code></pre>
+ </div>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">configuration-properties</code> is copied after it is generated by the Accumulo build.</p>
+
+ <div class="highlighter-rouge"><pre class="highlight"><code> cp /path/to/accumulo/core/target/generated-docs/configuration-properties.md /path/to/accumulo-website/_docs-2-x/administration/configuration-properties.md
+</code></pre>
+ </div>
+ </li>
+</ol>
+
<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>
+ <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 the directory name:</p>
<div class="highlighter-rouge"><pre class="highlight"><code> cp -r _docs-unreleased _docs-2-0
</code></pre>
@@ -290,14 +310,16 @@ automatically.</p>
<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>
+ <li>
+ <p>Copy <code class="highlighter-rouge">configuration-properties</code> and mirror <code class="highlighter-rouge">INSTALL.md</code>.</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 2.x bugfix releases,</strong> copy <code class="highlighter-rouge">configuration-properties</code> and mirror <code class="highlighter-rouge">INSTALL.md</code>.</p>
-<p><strong>For 1.x minor & 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>
+<p><strong>For 1.x minor & bugfix releases,</strong> copy <code class="highlighter-rouge">accumulo_user_manual.html</code> generated for release to the <code class="highlighter-rouge">1.x/</code> directory in the <a href="https://github.com/apache/accumulo-website">accumulo-website repo</a>.</p>
<h3 id="javadocs">Javadocs</h3>
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/459ae60a/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index ee22e5e..5d1156b 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 17:27:41 -0400</pubDate>
- <lastBuildDate>Tue, 06 Jun 2017 17:27:41 -0400</lastBuildDate>
+ <pubDate>Wed, 07 Jun 2017 09:58:39 -0400</pubDate>
+ <lastBuildDate>Wed, 07 Jun 2017 09:58:39 -0400</lastBuildDate>
<generator>Jekyll v3.3.1</generator>
<item>