You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2020/06/29 18:09:17 UTC

[geode] 03/04: GEODE-8304 - Better highlight steps for building documentation (#5308)

This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a commit to branch support/1.13
in repository https://gitbox.apache.org/repos/asf/geode.git

commit edabbe3692c2ec84d68f3a3a649a143a4067cd51
Author: Alexander Murmann <am...@pivotal.io>
AuthorDate: Fri Jun 26 09:17:17 2020 -0700

    GEODE-8304 - Better highlight steps for building documentation (#5308)
    
    Make it clearer that neither a local Bookbinder nor Ruby interpreter is
    needed to build our documentation book.
---
 dev-tools/docker/docs/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/dev-tools/docker/docs/README.md b/dev-tools/docker/docs/README.md
index b108509..5086b0e 100644
--- a/dev-tools/docker/docs/README.md
+++ b/dev-tools/docker/docs/README.md
@@ -2,13 +2,13 @@
 
 This document contains instructions for building and viewing the Apache Geode User Guide locally.
 
-Apache Geode provides the full source for the Apache Geode User Guide in markdown format (see `{geode-project-dir}/geode-docs/CONTRIBUTE.md`). For every Apache Geode release the user guide is built and published to http://geode.apache.org/docs/. Users can build the markdown into an HTML user guide using the provided Docker image, [Bookbinder](https://github.com/pivotal-cf/bookbinder), and the instructions below.
+Apache Geode provides the full source for the Apache Geode User Guide in markdown format (see `{geode-project-dir}/geode-docs/CONTRIBUTE.md`). For every Apache Geode release the user guide is built and published to http://geode.apache.org/docs/. Users can build the markdown into an HTML user guide by following the instructions below. The tooling builds upon a Docker image that includes [Bookbinder](https://github.com/pivotal-cf/bookbinder) and everything needed to run it. No local versio [...]
 
 The User Guide built in this way reflects any local updates you have made to the documentation source files in your local Apache Geode repository.
 
 ## Building the User Guide
 
-The `build-docs.sh` script invokes Bookbinder to transform the markdown files to HTML using Docker, which has been provisioned with Bookbinder and Ruby. To build the guide, run the script from a shell prompt:
+To build the guide, open a shell, cd into this directoy and run
 
 ```bash
 $ ./build-docs.sh