GEODE-2015: Edit links to docs info

GEODE-2015: Add images_svg, stylesheets to Rules passthrough GEODE-2015: Fix extension for Bookbinder update GEODE-2015: Update GemFire.lock for Bookbinder 10.0.2 Revert "GEODE-2015: Add images_svg, stylesheets to Rules passthrough" This reverts commit d942321. GEODE-2015: Point user guide link to new location GEODE-2015: Edit docs to work better with site GEODE-2015: Add to geode-book README steps to embed docs in site Update site README with User Guide info GEODE-2015: Fix user guide paths for website Fix redirects for docs/guide GEODE-2015: Improve README instructions GEODE-2015: Fix doc/site READMEs; fix docs link in project README Fix README spacing This closes apache#267
rbramwell · Oct 25, 2016 · a48871e · a48871e
1 parent b4b6e07
commit a48871e
Show file tree

Hide file tree

Showing 11 changed files with 1,019 additions and 1,009 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 **[Location of Directions for Building from Source](#building)**  
 **[Geode in 5 minutes](#started)**  
 **[Application Development](#development)**  
-**[Documentation](http://geode.docs.pivotal.io/)**  
+**[Documentation](http://geode.incubator.apache.org/docs/)**  
 **[wiki](https://cwiki.apache.org/confluence/display/GEODE/Index)**  
 **Continuous Integration** [![Build Status](https://travis-ci.org/apache/incubator-geode.svg?branch=develop)](https://travis-ci.org/apache/incubator-geode)  
 
@@ -63,7 +63,7 @@ _HelloWorld.java_
     import java.util.Map;
     import org.apache.geode.cache.Region;
     import org.apache.geode.cache.client.*;
-
+    
     public class HelloWorld {
       public static void main(String[] args) throws Exception {
         ClientCache cache = new ClientCacheFactory()
@@ -72,10 +72,10 @@ _HelloWorld.java_
         Region<String, String> region = cache
           .<String, String>createClientRegionFactory(ClientRegionShortcut.CACHING_PROXY)
           .create("region");
-
+    
         region.put("1", "Hello");
         region.put("2", "World");
-
+    
         for (Map.Entry<String, String>  entry : region.entrySet()) {
           System.out.format("key = %s, value = %s\n", entry.getKey(), entry.getValue());
         }

diff --git a/geode-book/Gemfile.lock b/geode-book/Gemfile.lock
@@ -9,16 +9,19 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     ansi (1.5.0)
-    bookbindery (9.12.0)
+    backports (3.6.8)
+    bookbindery (10.0.2)
       ansi (~> 1.4)
       css_parser
       elasticsearch
       fog-aws (~> 0.7.1)
       font-awesome-sass
       git (~> 1.2.8)
-      middleman (~> 3.4.0)
-      middleman-livereload (~> 3.4.3)
-      middleman-syntax (~> 2.0)
+      middleman
+      middleman-compass
+      middleman-livereload
+      middleman-sprockets
+      middleman-syntax
       nokogiri (= 1.6.7.2)
       puma
       rack-rewrite
@@ -27,13 +30,7 @@ GEM
       therubyracer
       thor
     builder (3.2.2)
-    capybara (2.4.4)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
-    chunky_png (1.3.6)
+    chunky_png (1.3.7)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -50,8 +47,11 @@ GEM
       sass (>= 3.3.0, < 3.5)
     compass-import-once (1.0.5)
       sass (>= 3.2, < 3.5)
+    concurrent-ruby (1.0.2)
+    contracts (0.13.0)
     css_parser (1.4.5)
       addressable
+    dotenv (2.1.1)
     elasticsearch (2.0.0)
       elasticsearch-api (= 2.0.0)
       elasticsearch-transport (= 2.0.0)
@@ -65,17 +65,20 @@ GEM
       http_parser.rb (~> 0.6.0)
     erubis (2.7.0)
     eventmachine (1.2.0.1)
-    excon (0.51.0)
+    excon (0.54.0)
     execjs (2.7.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
+    fast_blank (1.0.0)
+    fastimage (2.0.0)
+      addressable (~> 2)
     ffi (1.9.14)
     fog-aws (0.7.6)
       fog-core (~> 1.27)
       fog-json (~> 1.0)
       fog-xml (~> 0.1)
       ipaddress (~> 0.8)
-    fog-core (1.42.0)
+    fog-core (1.43.0)
       builder
       excon (~> 0.49)
       formatador (~> 0.2)
@@ -91,9 +94,9 @@ GEM
     git (1.2.9.1)
     haml (4.0.7)
       tilt
-    hike (1.2.3)
-    hooks (0.4.1)
-      uber (~> 0.0.14)
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashie (3.4.6)
     http_parser.rb (0.6.0)
     i18n (0.7.0)
     ipaddress (0.8.3)
@@ -103,80 +106,82 @@ GEM
     listen (3.0.8)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    middleman (3.4.1)
+    memoist (0.15.0)
+    middleman (4.1.10)
       coffee-script (~> 2.2)
-      compass (>= 1.0.0, < 2.0.0)
       compass-import-once (= 1.0.5)
-      execjs (~> 2.0)
       haml (>= 4.0.5)
       kramdown (~> 1.2)
-      middleman-core (= 3.4.1)
-      middleman-sprockets (>= 3.1.2)
+      middleman-cli (= 4.1.10)
+      middleman-core (= 4.1.10)
       sass (>= 3.4.0, < 4.0)
-      uglifier (~> 2.5)
-    middleman-core (3.4.1)
-      activesupport (~> 4.1)
+    middleman-cli (4.1.10)
+      thor (>= 0.17.0, < 2.0)
+    middleman-compass (4.0.1)
+      compass (>= 1.0.0, < 2.0.0)
+      middleman-core (>= 4.0.0)
+    middleman-core (4.1.10)
+      activesupport (~> 4.2)
+      addressable (~> 2.3)
+      backports (~> 3.6)
       bundler (~> 1.1)
-      capybara (~> 2.4.4)
+      contracts (~> 0.13.0)
+      dotenv
       erubis
-      hooks (~> 0.3)
+      execjs (~> 2.0)
+      fast_blank
+      fastimage (~> 2.0)
+      hamster (~> 3.0)
+      hashie (~> 3.4)
       i18n (~> 0.7.0)
-      listen (~> 3.0.3)
-      padrino-helpers (~> 0.12.3)
+      listen (~> 3.0.0)
+      memoist (~> 0.14)
+      padrino-helpers (~> 0.13.0)
+      parallel
       rack (>= 1.4.5, < 2.0)
-      thor (>= 0.15.2, < 2.0)
-      tilt (~> 1.4.1, < 2.0)
+      sass (>= 3.4)
+      servolux
+      tilt (~> 1.4.1)
+      uglifier (~> 3.0)
     middleman-livereload (3.4.6)
       em-websocket (~> 0.5.1)
       middleman-core (>= 3.3)
       rack-livereload (~> 0.3.15)
-    middleman-sprockets (3.4.2)
-      middleman-core (>= 3.3)
-      sprockets (~> 2.12.1)
-      sprockets-helpers (~> 1.1.0)
-      sprockets-sass (~> 1.3.0)
-    middleman-syntax (2.1.0)
+    middleman-sprockets (4.0.0)
+      middleman-core (~> 4.0)
+      sprockets (>= 3.0)
+    middleman-syntax (3.0.0)
       middleman-core (>= 3.2)
-      rouge (~> 1.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+      rouge (~> 2.0)
     mini_portile2 (2.0.0)
-    minitest (5.9.0)
+    minitest (5.9.1)
     multi_json (1.12.1)
     multipart-post (2.0.0)
     nokogiri (1.6.7.2)
       mini_portile2 (~> 2.0.0.rc2)
-    padrino-helpers (0.12.8)
+    padrino-helpers (0.13.3.2)
       i18n (~> 0.6, >= 0.6.7)
-      padrino-support (= 0.12.8)
-      tilt (~> 1.4.1)
-    padrino-support (0.12.8)
+      padrino-support (= 0.13.3.2)
+      tilt (>= 1.4.1, < 3)
+    padrino-support (0.13.3.2)
       activesupport (>= 3.1)
+    parallel (1.9.0)
     puma (3.6.0)
     rack (1.6.4)
     rack-livereload (0.3.16)
       rack
     rack-rewrite (1.5.1)
-    rack-test (0.6.3)
-      rack (>= 1.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     redcarpet (3.2.3)
     ref (2.0.0)
-    rouge (1.11.1)
+    rouge (2.0.6)
     sass (3.4.22)
-    sprockets (2.12.4)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-helpers (1.1.0)
-      sprockets (~> 2.0)
-    sprockets-sass (1.3.1)
-      sprockets (~> 2.0)
-      tilt (~> 1.1)
+    servolux (0.12.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
     therubyracer (0.12.2)
       libv8 (~> 3.16.14.0)
       ref
@@ -185,12 +190,8 @@ GEM
     tilt (1.4.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uber (0.0.15)
-    uglifier (2.7.2)
-      execjs (>= 0.3.0)
-      json (>= 1.8.0)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
+    uglifier (3.0.2)
+      execjs (>= 0.3.0, < 3)
 
 PLATFORMS
   ruby

diff --git a/geode-book/README.md b/geode-book/README.md
@@ -1,14 +1,18 @@
-# Apache Geode End-User Documentation
+# Apache Geode User Guide
 
-Apache Geode provides the full source for end-user documentation in markdown format (see `../geode-docs/CONTRIBUTE.md`). The latest check-ins to `incubator-geode/geode-docs` are regularly built and published to http://geode.incubator.apache.org/docs/. Users can build the markdown into an HTML user guide using [Bookbinder](https://github.com/pivotal-cf/bookbinder) and the instructions below.
-
-Bookbinder is a Ruby gem that binds  a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application.
-
-This document contains instructions for building and viewing the Geode documentation locally.
+This document contains instructions for building and viewing the Apache Geode User Guide locally.
 
+- [About](#about)
 - [Prerequisites](#prerequisites)
 - [Bookbinder Usage](#bookbinder-usage)
 - [Building the Documentation](#building-the-documentation)
+- [Embedding the User Guide in the Geode Website](#embedding-the-user-guide-in-the-geode-website)
+
+## About
+
+Apache Geode provides the full source for the Apache Geode User Guide in markdown format (see `{geode-project-dir}/geode-docs/CONTRIBUTE.md`). The latest check-ins to `{geode-project-dir}/geode-docs` on the `develop` branch are regularly built and published to http://geode.incubator.apache.org/docs/. Users can build the markdown into an HTML user guide using [Bookbinder](https://github.com/pivotal-cf/bookbinder) and the instructions below.
+
+Bookbinder is a Ruby gem that binds  a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [Middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a web application.
 
 ## Prerequisites
 
@@ -23,38 +27,66 @@ Follow the instructions below to install Bookbinder:
 
 Bookbinder is meant to be used from within a project called a **book**. The book includes a configuration file that describes which documentation repositories to use as source materials. Bookbinder provides a set of scripts to aggregate those repositories and publish them to various locations.
 
-For Geode, a preconfigured **book** is provided in the directory `geode-book`, which gathers content from the directory `geode-docs`. You can use this configuration to build HTML for Geode on your local system.
-
-The installed `config.yml` file configures the Geode book for building locally. The file configures the local directory for the markdown source files.
+For Geode, a preconfigured **book** is provided in the directory `{geode-project-dir}/geode-book`, which gathers content from the directory `{geode-project-dir}/geode-docs`. You can use this configuration to build an HTML version of the Apache Geode User Guide on your local system.
 
 ## Building the Documentation
 
-1. The GemFile in the `geode-book` directory already defines the `gem "bookbindery"` dependency. Make sure you are in the `geode-book` directory and enter:
+1. The GemFile in the `geode-book` directory already defines the `gem "bookbindery"` dependency. Make sure you are in the `{geode-project-dir}/geode-book` directory and enter:
 
-```
-  $ bundle install
-```
+    ```
+    $ bundle install
+    ```
 
    Note: You will not have to run `bundle install` on subsequent builds.
 
 2. To build the documentation locally using the installed `config.yml` file, enter:
 
-```
-  $ bundle exec bookbinder bind local
-```
+    ```
+    $ bundle exec bookbinder bind local
+    ```
+
    Bookbinder converts the markdown source into HTML, which it puts in the `final_app` directory.
 
-3. Navigate to the `geode-book/final_app/` and enter:
+3. Navigate to `{geode-project-dir}/geode-book/final_app/` and enter:
+
+    ```
+    $ bundle install
+    ```
 
-  ```
-  $ bundle install
-  ```
    Note: You will not have to run `bundle install` on subsequent builds.
 
-4. To start the website locally, enter:
+4. To start a local website of the Apache Geode User Guide, enter:
+
+    ```
+    $ rackup
+    ```
+
+   You can now view the local documentation at <http://localhost:9292>. 
+
+## Embedding the User Guide in the Geode Website
+
+Once you have reviewed your local build of the User Guide, you can embed it in the Apache Geode website by doing the following:
+
+1. Compile the website source *before adding the User Guide files*. In the `{geode-project-dir}/geode-site/website` directory, enter:
+
+    ```
+    $ nanoc compile
+    ```
+
+2. Move the built User Guide files to the Geode website. Navigate to: `{geode-project-dir}/geode-book/final_app/public/` and enter:
+
+    ```
+    $ tar cvf ~/Desktop/new-guide-content.tar .
+    $ cd ../../../geode-site/content
+    $ tar xvf ~/Desktop/new-guide-content.tar
+    ```
+
+3. In the `{geode-project-dir}/geode-site/website` directory, enter:
+
+    ```
+    $ nanoc view
+    ```
 
-  ```
-  $ rackup
-  ```
+   You can now view the local website at http://localhost:3000.
 
-   You can now view the local documentation at <http://localhost:9292>. 
+4. Once you have reviewed your changes, follow the instructions at `{geode-project-dir}/geode-site/website/README.md` for propagating changes to the `asf-site` branch.
diff --git a/geode-book/config.yml b/geode-book/config.yml
@@ -21,7 +21,7 @@ public_host: localhost
 sections:
 - repository:
     name: geode-docs
-  directory: docs
+  directory: docs/guide
   subnav_template: geode-subnav
 
 template_variables: