This is an automated email from the ASF dual-hosted git repository.
mwalch pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/fluo-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 1c968ae Jekyll build from gh-pages:503e462
1c968ae is described below
commit 1c968ae6675e995c590ab58eae2120e15c2e2ac2
Author: Mike Walch <[email protected]>
AuthorDate: Tue Oct 3 17:06:23 2017 -0400
Jekyll build from gh-pages:503e462
Updated release instructions and moved Fluo 1.2 collection (#98)
* Fluo 1.2 docs were moved to _fluo-1-2 to simplify collections names
* Updated release intructions in README.md
---
README.md | 53 +++++++++++++++--------------
docs/fluo/1.2/administration/metrics.html | 4 +--
docs/fluo/1.2/development/applications.html | 4 +--
docs/fluo/1.2/getting-started/design.html | 4 +--
docs/fluo/1.2/getting-started/install.html | 4 +--
docs/fluo/1.2/index.html | 4 +--
feed.xml | 4 +--
7 files changed, 39 insertions(+), 38 deletions(-)
diff --git a/README.md b/README.md
index 919b766..7d7a82f 100644
--- a/README.md
+++ b/README.md
@@ -3,43 +3,44 @@
Code powering the Apache Fluo website
([https://fluo.apache.org](https://fluo.apache.org)).
[Contributing](CONTRIBUTING.md) decribes how to test locally.
-## Apache Fluo releases
+## Update website for new release
-Below are the steps required to update the Fluo project website for a new
release
-(substitute `1.0.0-beta-1` with the version of your release):
+Below are the steps required to update the Fluo project website for a new
release
+of Fluo or Fluo Recipes. The steps below assume you are releasing Fluo 1.2.0.
For
+a Fluo Recipes release, replace any reference to `fluo` with `recipes`.
-1. Run the commands below to copy and convert documentation in your release
tag of
- your Fluo repo to this repo:
+1. Confirm that Javadocs for the release are hosted externally
- ```bash
- cd fluo-website/
- mkdir -p docs/fluo/1.0.0-beta-1
- ./_scripts/convert-fluo-docs.py /path/to/fluo/docs/
/path/to/fluo-website/docs/fluo/1.0.0-beta-1/
- ```
+2. Modify `_config.yml` for the new release:
-2. Modify `docs/index.md` to point to new release and update the
`latest_fluo_release`
- variable in `_config.yml`.
+ * Set `latest_fluo_release` to `1.2.0`
+ * Verify default values (i.e Javadoc & GitHub URLs) set for `fluo-1-2`
collection
-3. Confirm that javadocs are hosted externally and modify `pages/api.md` to
point to link to them.
+3. Remove the "Future release" warning from the Fluo docs layout in
`_layouts/fluo-1.2.html`
-4. Create a post in `_posts/release` with release notes and resources to
announce release.
+4. Add link to 1.2 documentation in `docs/index.md`.
-## Apache Fluo Recipes releases
+5. Add link to 1.2 javadocs in `pages/api.md`.
-Steps to update website for new Fluo Recipes release:
+6. If a post exists for the release in `_posts/release`, update the date and
remove `draft: true`
+ from the post to publish it. Otherwise, create a post with release notes
and resources to announce
+ the release.
-1. Run the commands below to copy and convert documentation in your release
tag.
+## Create documentation for next release
- ```bash
- cd fluo-website
- mkdir -p docs/fluo-recipes/1.0.0-beta-1
- ./_scripts/convert-recipes-docs.py /path/to/fluo-recipes/docs/
/path/to/fluo-website/docs/fluo-recipes/1.0.0-beta-1/
- ```
+Below are steps to create documentaton for the next release of Fluo or Fluo
Recipes. The
+directions below are for creating Fluo 1.3 docs from 1.2 docs. For Fluo
Recipes documentation,
+replace any reference to `fluo` with `recipes`.
-2. Modify `docs/index.md` to point to new release and update the
`latest_recipes_release` variable in `_config.yml`.
+1. Create the Fluo 1.3 docs from the 1.2 docs
-3. Confirm that javadocs are hosted externally and modify `pages/api.md` to
point to link to them.
+ cp -r _fluo-1-2 _fluo-1-3
-4. Create a post in `_posts/release` with release notes and resources to
announce release.
+2. Create a `fluo-1.3.html` layout and update any collection references in it
to `fluo-1-3`.
+ You should also add a warning banner to notify users that it's for a future
release.
-[instructions]: http://jekyllrb.com/docs/installation/
+ cp _layouts/fluo-1.2.html _layouts/fluo-1.3.html
+ vim _layout/fluo-1.3.html
+
+3. Update `_config.yml` by adding a `fluo-1-3` collection and setting default
values for it.
+ You may want to keep 1.2 values for github & javadocs until 1.3 is released.
diff --git a/docs/fluo/1.2/administration/metrics.html
b/docs/fluo/1.2/administration/metrics.html
index 7366588..933ff2c 100644
--- a/docs/fluo/1.2/administration/metrics.html
+++ b/docs/fluo/1.2/administration/metrics.html
@@ -209,7 +209,7 @@
<div class="row">
<div class="col-md-10"><h1>Metrics</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/administration/metrics.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/metrics.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
<p>A Fluo application can be configured (in <a
href="https://github.com/apache/fluo/blob/master/modules/distribution/src/main/config/fluo-app.properties";>fluo-app.properties</a>)
to report metrics. When metrics are
@@ -447,7 +447,7 @@ viewing metrics.</p>
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases
in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/administration/metrics.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/administration/metrics.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/development/applications.html
b/docs/fluo/1.2/development/applications.html
index d90588d..3dce529 100644
--- a/docs/fluo/1.2/development/applications.html
+++ b/docs/fluo/1.2/development/applications.html
@@ -209,7 +209,7 @@
<div class="row">
<div class="col-md-10"><h1>Applications</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/development/applications.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/development/applications.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
<p>Once you have Fluo installed and running on your cluster, you can run
Fluo applications consisting
@@ -569,7 +569,7 @@ where D is a hex digit. Also the <code
class="highlighter-rouge">\</code> charac
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases
in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/development/applications.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/development/applications.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/getting-started/design.html
b/docs/fluo/1.2/getting-started/design.html
index 81aadf5..9581528 100644
--- a/docs/fluo/1.2/getting-started/design.html
+++ b/docs/fluo/1.2/getting-started/design.html
@@ -209,7 +209,7 @@
<div class="row">
<div class="col-md-10"><h1>Design</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/getting-started/design.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/design.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
<p>The diagram below provides an overview of Apache Fluo’s design.</p>
@@ -260,7 +260,7 @@ required for Accumulo.</li>
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases
in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/getting-started/design.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/design.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/getting-started/install.html
b/docs/fluo/1.2/getting-started/install.html
index 3684364..7e7b737 100644
--- a/docs/fluo/1.2/getting-started/install.html
+++ b/docs/fluo/1.2/getting-started/install.html
@@ -209,7 +209,7 @@
<div class="row">
<div class="col-md-10"><h1>Installation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/getting-started/install.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
<p>Instructions for installing Apache Fluo and starting a Fluo application
on a cluster where
@@ -385,7 +385,7 @@ probably increase the <code
class="highlighter-rouge">tserver.server.threads.min
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases
in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/getting-started/install.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/getting-started/install.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
</div>
</div>
diff --git a/docs/fluo/1.2/index.html b/docs/fluo/1.2/index.html
index 5fe2366..c44185f 100644
--- a/docs/fluo/1.2/index.html
+++ b/docs/fluo/1.2/index.html
@@ -207,7 +207,7 @@
<div class="row">
<div class="col-md-10"><h1>Apache Fluo documentation</h1></div>
- <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/index.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right" style="margin-top: 25px;"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
<p><!DOCTYPE html></p>
@@ -224,7 +224,7 @@
<div class="row" style="margin-top: 20px;">
<div class="col-md-10"><strong>Find documentation for all Fluo releases
in the <a href="/docs/">archive</strong></div>
- <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-docs-1-2/index.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
+ <div class="col-md-2"><a class="pull-right"
href="https://github.com/apache/fluo-website/edit/master/_fluo-1-2/index.md";
role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this
page</small></a></div>
</div>
</div>
</div>
diff --git a/feed.xml b/feed.xml
index 899a37f..44540c0 100644
--- a/feed.xml
+++ b/feed.xml
@@ -5,8 +5,8 @@
<description></description>
<link>https://fluo.apache.org//</link>
<atom:link href="https://fluo.apache.org//feed.xml"; rel="self"
type="application/rss+xml" />
- <pubDate>Tue, 03 Oct 2017 17:34:31 +0000</pubDate>
- <lastBuildDate>Tue, 03 Oct 2017 17:34:31 +0000</lastBuildDate>
+ <pubDate>Tue, 03 Oct 2017 21:06:18 +0000</pubDate>
+ <lastBuildDate>Tue, 03 Oct 2017 21:06:18 +0000</lastBuildDate>
<generator>Jekyll v3.3.1</generator>
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
