Apache Geode User Guide

This document contains instructions for building and viewing the Apache Geode User Guide locally and moving the built guide to the Apache Geode website for publication.

• About
• Preview the User Guide
• Build the User Guide
  • Prerequisites
  • Bookbinder Usage
  • Building the Documentation
• Publishing the User Guide to 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). 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 Bookbinder and the instructions below.

Bookbinder is a Ruby gem (available at rubygems.org ) 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 to produce a Rackup app that can be deployed locally or as a web application.

Preview the User Guide

Documentation can be built and previewed using the utility script at {geode-project-dir}/dev-tools/docker/docs. This script uses a Docker image that provides the tools to build and view the guide, including Ruby, Bookbinder, and Rackup.

$ cd {geode-project-dir}/dev-tools/docker/docs
$ ./preview-user-guide.sh

Once the script shows it is listening on a local address, you could use a browser to view the user guide on that address.

For example:

$ ./preview-user-guide.sh
...
...
Puma starting in single mode...
* Version 4.3.8 (ruby 2.5.9-p229), codename: Mysterious Traveller
* Min threads: 0, max threads: 16
* Environment: development
* Listening on tcp://0.0.0.0:9292
Use Ctrl-C to stop

You will find the user guide at 0.0.0.0:9292.

You can find the files generated by Bookbinder at {geode-project-dir}/geode-book/final_app. To view the generated files after exiting the preview-user-guide.sh script:

1. Run Rackup from the final_app directory.
2. In a web browser, open http://localhost:9292.

Example:

$ cd {geode-project-dir}/geode-book/final_app
$ bundle exec rackup

Build the User Guide

Prerequisites

Bookbinder requires Ruby version 2.3.3 or higher.

Bookbinder Usage

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-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-project-dir}/geode-book directory and enter:

   $ cd {geode-project-dir}/geode-book
   $ 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
   

   Bookbinder converts the markdown source into HTML, which it puts in the final_app directory.

3. To start a local website of the Apache Geode User Guide, you have to execute Rackup from the final_app directory:

   $ cd {geode-project-dir}/geode-book/final_app
   $ bundle exec rackup
   

   You can now view the local documentation at http://localhost:9292.

Publishing the User Guide to the Geode Website

Once you have reviewed your local build of the User Guide, you can publish it by copying it to the Apache Geode website. The target directory should contain a Geode version number.

To copy the User Guide to the website repository, follow the instructions in the README.md file on the master branch of the geode-site repository (github: https://github.com/apache/geode-site) under the topic Add a new user guide.