This is an automated email from the ASF dual-hosted git repository.
mwalch pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/fluo-website.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 503e462 Updated release instructions and moved Fluo 1.2 collection
(#98)
503e462 is described below
commit 503e46256439eaff882051b83bc274c02154b290
Author: Mike Walch <[email protected]>
AuthorDate: Tue Oct 3 17:01:40 2017 -0400
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 +++++++++++-----------
_config.yml | 8 ++--
.../administration/metrics.md | 0
.../development/applications.md | 0
.../getting-started/design.md | 0
.../getting-started/install.md | 0
{_fluo-docs-1-2 => _fluo-1-2}/index.md | 0
_layouts/{fluo-docs-1.2.html => fluo-1.2.html} | 2 +-
8 files changed, 32 insertions(+), 31 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/_config.yml b/_config.yml
index 05ef091..35302ab 100644
--- a/_config.yml
+++ b/_config.yml
@@ -7,7 +7,7 @@ permalink: pretty
# Collection names cannot contain periods
collections:
- fluo-docs-1-2:
+ fluo-1-2:
output: true
permalink: "/docs/fluo/1.2/:path"
recipes-1-2:
@@ -45,10 +45,10 @@ defaults:
permalink: "/tour/:basename/"
-
scope:
- path: "_fluo-docs-1-2"
- type: "fluo-docs-1-2"
+ path: "_fluo-1-2"
+ type: "fluo-1-2"
values:
- layout: "fluo-docs-1.2"
+ layout: "fluo-1.2"
title_prefix: "Fluo Documentation - "
version: "1.2.0"
minor_release: "1.2"
diff --git a/_fluo-docs-1-2/administration/metrics.md
b/_fluo-1-2/administration/metrics.md
similarity index 100%
rename from _fluo-docs-1-2/administration/metrics.md
rename to _fluo-1-2/administration/metrics.md
diff --git a/_fluo-docs-1-2/development/applications.md
b/_fluo-1-2/development/applications.md
similarity index 100%
rename from _fluo-docs-1-2/development/applications.md
rename to _fluo-1-2/development/applications.md
diff --git a/_fluo-docs-1-2/getting-started/design.md
b/_fluo-1-2/getting-started/design.md
similarity index 100%
rename from _fluo-docs-1-2/getting-started/design.md
rename to _fluo-1-2/getting-started/design.md
diff --git a/_fluo-docs-1-2/getting-started/install.md
b/_fluo-1-2/getting-started/install.md
similarity index 100%
rename from _fluo-docs-1-2/getting-started/install.md
rename to _fluo-1-2/getting-started/install.md
diff --git a/_fluo-docs-1-2/index.md b/_fluo-1-2/index.md
similarity index 100%
rename from _fluo-docs-1-2/index.md
rename to _fluo-1-2/index.md
diff --git a/_layouts/fluo-docs-1.2.html b/_layouts/fluo-1.2.html
similarity index 97%
rename from _layouts/fluo-docs-1.2.html
rename to _layouts/fluo-1.2.html
index c53ffd3..28e774b 100644
--- a/_layouts/fluo-docs-1.2.html
+++ b/_layouts/fluo-1.2.html
@@ -6,7 +6,7 @@ layout: default
<div class="col-md-2">
<div class="panel-group" id="accordion" role="tablist"
aria-multiselectable="true" data-spy="affix">
<div class="panel panel-default">
- {% assign mydocs = site.fluo-docs-1-2 | group_by: 'category' %}
+ {% assign mydocs = site.fluo-1-2 | group_by: 'category' %}
{% assign categories = "getting-started,development,administration" |
split: "," %}
{% for pcat in categories %}
{% for dcat in mydocs %}
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
