geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dbar...@apache.org
Subject geode git commit: GEODE-3396 Provide pub-tools support for product name & version variables. Adjustments to accommodate Bookbinder changes.
Date Tue, 08 Aug 2017 20:12:03 GMT
Repository: geode
Updated Branches:
  refs/heads/develop 79cf78c9b -> b775c8451


GEODE-3396 Provide pub-tools support for product name & version variables. Adjustments
to accommodate Bookbinder changes.


Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/b775c845
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/b775c845
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/b775c845

Branch: refs/heads/develop
Commit: b775c8451ed41c6f2c6407a317c373e96d0b8814
Parents: 79cf78c
Author: Dave Barnes <dbarnes@pivotal.io>
Authored: Tue Aug 8 13:11:26 2017 -0700
Committer: Dave Barnes <dbarnes@pivotal.io>
Committed: Tue Aug 8 13:11:26 2017 -0700

----------------------------------------------------------------------
 geode-book/config.yml    |  6 +++---
 geode-docs/CONTRIBUTE.md | 11 ++++++-----
 2 files changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode/blob/b775c845/geode-book/config.yml
----------------------------------------------------------------------
diff --git a/geode-book/config.yml b/geode-book/config.yml
index 7e51226..3c6e9c9 100644
--- a/geode-book/config.yml
+++ b/geode-book/config.yml
@@ -25,9 +25,9 @@ sections:
   subnav_template: geode-subnav
 
 template_variables:
-  geode_product_name_long: Apache Geode
-  geode_product_name: Geode
-  geode_product_version: 1.2
+  product_name_long: Apache Geode
+  product_name: Geode
+  product_version: 1.2
   support_url: http://geode.apache.org/community
   product_url: http://geode.apache.org/
   book_title: Apache Geode Documentation

http://git-wip-us.apache.org/repos/asf/geode/blob/b775c845/geode-docs/CONTRIBUTE.md
----------------------------------------------------------------------
diff --git a/geode-docs/CONTRIBUTE.md b/geode-docs/CONTRIBUTE.md
index 7feebc9..1393e9d 100644
--- a/geode-docs/CONTRIBUTE.md
+++ b/geode-docs/CONTRIBUTE.md
@@ -57,9 +57,9 @@ For flexibility, the product name (a long version and a short one) and version
a
 
 ```
 template_variables:
-  - geode_product_name_long: Apache Geode
-  - geode_product_name: Geode
-  - geode_product_version: 1.2
+  - product_name_long: Apache Geode
+  - product_name: Geode
+  - product_version: 1.2
 
 ```
 
@@ -79,7 +79,7 @@ Instead of:
     
 Do this:
 
-    <% set_title(geode_product_name_long, geode_product_version, "Documentation") %>
+    <% set_title(product_name_long, product_version, "Documentation") %>
 
 Why? Because the `title:` construct is not Ruby code, it's YAML, and it cannot interpret
Ruby variables.
 
@@ -87,7 +87,8 @@ Why? Because the `title:` construct is not Ruby code, it's YAML, and it
cannot i
 
   - Begin with `<%`, not `<%=`. (We're invoking a function, not printing its value.)
   - Do not put a space before the opening parenthesis (use `set_title(` not `set_title (`.)
-  - **Do not** quote the three product variable names (`geode_product_name`, `geode_product_name_long`,
and `geode_product_version`). **Do** quote all other text.
+  - **Do not** quote the three product variable names (`product_name`, `product_name_long`,
and `product_version`). **Do** quote all other text.
+  - This feature requires Bookbinder v10.1.7 (Aug 2017) or later.
 
 
 


Mime
View raw message