geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kl...@apache.org
Subject [43/50] [abbrv] geode git commit: Update geode-book README instructions
Date Tue, 13 Jun 2017 00:30:18 GMT
Update geode-book README instructions


Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/ad4e405f
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/ad4e405f
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/ad4e405f

Branch: refs/heads/feature/GEODE-2558
Commit: ad4e405f86364aa59e59616d78303961724ffed4
Parents: f541043
Author: Dave Barnes <dbarnes@pivotal.io>
Authored: Mon Jun 12 11:21:31 2017 -0700
Committer: Dave Barnes <dbarnes@pivotal.io>
Committed: Mon Jun 12 11:22:08 2017 -0700

----------------------------------------------------------------------
 geode-book/README.md | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode/blob/ad4e405f/geode-book/README.md
----------------------------------------------------------------------
diff --git a/geode-book/README.md b/geode-book/README.md
index db753f7..f381b16 100644
--- a/geode-book/README.md
+++ b/geode-book/README.md
@@ -65,17 +65,27 @@ For Geode, a preconfigured **book** is provided in the directory `{geode-project
 
 ## Publishing the User Guide to the Geode Website
 
-Once you have reviewed your local build of the User Guide, you can move it to the Apache
Geode website by doing the following:
+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.

 
-1. Navigate to: `{geode-project-dir}/geode-book/final_app/public/docs/guide/NN`, where `NN`
is the product version of your documentation (e.g., `{geode-project-dir}/geode-book/final_app/public/docs/guide/11`
if you are building the documentation for Apache Geode 1.1).
+To copy the User Guide to the website repo:
 
-2. To move the directory, enter:
+1. Create the destination directory by navigating to the geode-site repo. Check out the *master*
branch and create a destination directory for the User Guide. The naming convention is:
+
+    ```
+{geode-site}/website/content/docs/guide/XY
+    ```
+where `XY` is the product version of your documentation (e.g., `{geode-site}/website/content/docs/guide/12`
if you are publishing the documentation for Apache Geode 1.2).
+
+2. Navigate to the User Guide you have built in the Geode repository: `{geode-project-dir}/geode-book/final_app/public/docs/guide/XY`.
+
+3. Use `tar` to copy the directory in order to preserve links and other filesystem niceties.
Create the tarfile in your Desktop for easy access on the retrieval side.
+  
+  To copy the directory, enter:
 
     ```
     $ tar cvf ~/Desktop/new-guide-content.tar .
-    $ cd ../../../../../../geode-site/website/content/docs/guide/NN
+    $ cd {geode-site}/website/content/docs/guide/XY
     $ tar xvf ~/Desktop/new-guide-content.tar
     ```
-   **Note:** If the "`NN`" directory doesn't exist in the `{geode-project-dir}/geode-site/website/content/docs/guide/`
directory, you will need to create it first.
 
-3. Follow the instructions at `{geode-project-dir}/geode-site/website/README.md` to build,
review, and publish the Apache Geode website.
+4. Follow the instructions in the README.md file on the *master* branch of the geode-site
repo (`{geode-site}/README.md`) to build, review, and publish the Apache Geode website. You
can also view the geode-site README.md file on [github: https://github.com/apache/geode-site](https://github.com/apache/geode-site).


Mime
View raw message