tree: 4958fcfa316c69f79ae6d62d04e080cfb54fef84 [path history] [tgz]
  1. README.md
  2. api/
  3. docker/
  4. geode-native-book-cpp/
  5. geode-native-book-dotnet/
  6. geode-native-docs-cpp/
  7. geode-native-docs-dotnet/
  8. manual-build/
docs/README.md

Apache Geode Native Client User Guides

This document contains instructions for building and viewing the Apache Geode Native Client User Guides.

About

The Geode-Native repository provides the full source for the Apache Geode Native Client User Guides in markdown format (see geode-project-dir/geode-docs/CONTRIBUTE.md for more information on how to use markdown in this context). Users can build the markdown into an HTML user guide using Bookbinder and the instructions below.

The User Guide can be produced in two versions: one for the .NET native client, the other for the C++ native client.

Automatic build

Documentation can be built and previewed using the utility scripts at docs/docker. These scripts use Docker, removing the requirement of installing Ruby and Bookbinder. They are based on the instructions described in docs/manual-build.

Manual build

Documentation can be built in a less-automated way, as described at docs/manual-build.