Repository: incubator-hawq-docs Updated Branches: refs/heads/master 52ce16bfb -> c3d7896c3
updating readme for new book config location [HAWQ-1027] Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/6c5a29da Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/6c5a29da Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/6c5a29da Branch: refs/heads/master Commit: 6c5a29da88d207d1181ae7f88e0a2faa1dc74fcf Parents: bec5e3e Author: David Yozie <[email protected]> Authored: Mon Aug 29 10:06:02 2016 -0700 Committer: David Yozie <[email protected]> Committed: Mon Aug 29 10:07:38 2016 -0700 ---------------------------------------------------------------------- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/6c5a29da/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 3ba3492..8a794a7 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This document contains instructions for building the local Apache HAWQ (incubati 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 Apache HAWQ (incubating), a preconfigured **book** is provided in the directory `/hawq-book`. You can use this configuration to build HTML for Apache HAWQ (incubating) on your local system. +For Apache HAWQ (incubating), a preconfigured **book** is provided in a separate branch named `book`. You can use this configuration to build HTML for Apache HAWQ (incubating) on your local system. <a name="prereq"></a> ## Prerequisites @@ -27,10 +27,10 @@ For Apache HAWQ (incubating), a preconfigured **book** is provided in the direct <a name="building"></a> ## Building the Documentation -1. Begin by moving or copying the `/hawq-book directory` to a directory that is parallel to `incubator-hawq/docs-apache-hawq-md`. For example: +1. Begin by cloning the `book` branch of this repository to a new directory that is parallel to `apache/incubator-hawq-docs`. For example: - $ cd /repos/incubator-hawq/docs-apache-hawq-md - $ cp -r hawq-book .. + $ cd /repos/apache/incubatoro-hawq-docs + $ git clone --branch book [email protected]:apache/incubator-hawq-docs.git ../hawq-book $ cd ../hawq-book 2. The GemFile in the book directory already defines the `gem "bookbindery"` dependency. Make sure you are in the relocated book directory and enter:
