This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 8828173 GEODE-9568-User-Guide-script-keeps-generated-files (#7518)
8828173 is described below
commit 88281735a48cf46d6682e7ca444eecbf339e681b
Author: Max Hufnagel <[email protected]>
AuthorDate: Wed Mar 30 20:58:35 2022 -0700
GEODE-9568-User-Guide-script-keeps-generated-files (#7518)
Add explanation: What to do with the generated files
---
geode-book/README.md | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)
diff --git a/geode-book/README.md b/geode-book/README.md
index 07c8569..01eb967 100644
--- a/geode-book/README.md
+++ b/geode-book/README.md
@@ -3,11 +3,11 @@
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](#about)
-- [Automatic build](#automatic-build)
-- [Manual build](#manual-build)
- - [Prerequisites](#prerequisites)
- - [Bookbinder Usage](#bookbinder-usage)
- - [Building the Documentation](#building-the-documentation)
+- [Preview the User Guide](#preview-the-user-guide)
+- [Build the User Guide](#build-the-user-guide)
+ - [Prerequisites](#prerequisites)
+ - [Bookbinder Usage](#bookbinder-usage)
+ - [Building the Documentation](#building-the-documentation)
- [Publishing the User Guide to the Geode
Website](#publishing-the-user-guide-to-the-geode-website)
## About
@@ -41,8 +41,18 @@ Use Ctrl-C to stop
```
You will find the user guide at `0.0.0.0:9292`.
-Files generated by Bookbinder will be at
`{geode-project-dir}/geode-book/final_app`
-
+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
@@ -91,4 +101,4 @@ For Geode, a preconfigured **book** is provided in the
directory `{geode-project
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 repo, follow the instructions in the
`README.md` file on the *master* branch of the geode-site repo ([github:
https://github.com/apache/geode-site](https://github.com/apache/geode-site))
under the topic **Add a new user guide**.
+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](https://github.com/apache/geode-site))
under the topic **Add a new user guide**.
