You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by sb...@apache.org on 2016/10/25 06:20:48 UTC
[42/50] [abbrv] incubator-geode git commit: Edit README; rm pdf_header
Edit README; rm pdf_header
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/14a32e2e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/14a32e2e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/14a32e2e
Branch: refs/heads/master
Commit: 14a32e2ebaa88726e3d70c9b69c1aacae3f3b4e1
Parents: 0b31275
Author: Joey McAllister <jm...@pivotal.io>
Authored: Wed Oct 12 13:38:00 2016 -0700
Committer: Joey McAllister <jm...@pivotal.io>
Committed: Wed Oct 12 13:38:00 2016 -0700
----------------------------------------------------------------------
.../master_middleman/source/pdf_header.html | 7 -----
geode-docs/README.md | 27 ++------------------
2 files changed, 2 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/14a32e2e/geode-book/master_middleman/source/pdf_header.html
----------------------------------------------------------------------
diff --git a/geode-book/master_middleman/source/pdf_header.html b/geode-book/master_middleman/source/pdf_header.html
deleted file mode 100644
index a1925fd..0000000
--- a/geode-book/master_middleman/source/pdf_header.html
+++ /dev/null
@@ -1,7 +0,0 @@
-<!DOCTYPE html>
-<html>
- <body>
- <div class='pdf_header' style="background-color:#00786e; padding:12px 0px 12px 10px">
- </div>
- </body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/14a32e2e/geode-docs/README.md
----------------------------------------------------------------------
diff --git a/geode-docs/README.md b/geode-docs/README.md
index 199906e..9564079 100644
--- a/geode-docs/README.md
+++ b/geode-docs/README.md
@@ -2,7 +2,7 @@
Apache Geode provides the full source for end-user documentation in markdown format. 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 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.
+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.
@@ -25,30 +25,7 @@ Bookbinder is meant to be used from within a project called a **book**. The book
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. It uses the following configuration:
-
- ```
-book_repo: apache/incubator-geode/geode-book
-public_host: localhost
-
-sections:
-- repository:
- name: geode-docs
- directory: docs
- subnav_template: geode-subnav
-
-template_variables:
- support_url: http://geode.incubator.apache.org/community
- product_url: http://geode.incubator.apache.org/
- book_title: Apache Geode (Incubating) Documentation
- support_link: <a href="http://geode.incubator.apache.org/community" target="_blank">Community</a>
- support_call_to_action: <a href="http://geode.incubator.apache.org/community" target="_blank">Need Help?</a>
- product_link: <div class="header-item"><a href="http://geode.incubator.apache.org/">Back to Geode Page</a></div>
- domain_name: apache.org
- book_title_short: Geode Docs
-
-broken_link_exclusions: iefix|using_custom_classes|arrowhead|cppdocs|DotNetDocs
- ```
+The installed `config.yml` file configures the Geode book for building locally. The file configures the local directory for the markdown source files.
## Building the Documentation