geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kmil...@apache.org
Subject [66/66] [abbrv] geode git commit: GEODE-2031 Update README instructions for docs, website
Date Mon, 16 Jan 2017 23:48:25 GMT
GEODE-2031 Update README instructions for docs, website


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

Branch: refs/heads/develop
Commit: b8adff23c99f498f54148629941d1b8a38df6a30
Parents: 42130ad
Author: joeymcallister <jmcallister@pivotal.io>
Authored: Wed Jan 11 12:08:50 2017 -0800
Committer: Karen Miller <kmiller@pivotal.io>
Committed: Mon Jan 16 15:47:01 2017 -0800

----------------------------------------------------------------------
 geode-book/README.md         | 27 ++++++++-------------------
 geode-site/website/README.md |  6 ++----
 2 files changed, 10 insertions(+), 23 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode/blob/b8adff23/geode-book/README.md
----------------------------------------------------------------------
diff --git a/geode-book/README.md b/geode-book/README.md
index d69354b..f708ea6 100644
--- a/geode-book/README.md
+++ b/geode-book/README.md
@@ -1,6 +1,6 @@
 # Apache Geode User Guide
 
-This document contains instructions for building and viewing the Apache Geode User Guide
locally.
+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)
 - [Prerequisites](#prerequisites)
@@ -63,30 +63,19 @@ For Geode, a preconfigured **book** is provided in the directory `{geode-project
 
    You can now view the local documentation at <http://localhost:9292>. 
 
-## Embedding the User Guide in the Geode Website
+## Publishing the User Guide to the Geode Website
 
-Once you have reviewed your local build of the User Guide, you can embed it in the Apache
Geode website by doing the following:
+Once you have reviewed your local build of the User Guide, you can move it in the Apache
Geode website by doing the following:
 
-1. Compile the website source *before adding the User Guide files*. In the `{geode-project-dir}/geode-site/website`
directory, enter:
+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).
 
-    ```
-    $ nanoc compile
-    ```
-
-2. Move the built User Guide files to the Geode website. Navigate to: `{geode-project-dir}/geode-book/final_app/public/`
and enter:
+2. To move the directory, enter:
 
     ```
     $ tar cvf ~/Desktop/new-guide-content.tar .
-    $ cd ../../../geode-site/content
+    $ cd ../../../../../../geode-site/website/content/docs/guide/NN
     $ 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. In the `{geode-project-dir}/geode-site/website` directory, enter:
-
-    ```
-    $ nanoc view
-    ```
-
-   You can now view the local website at http://localhost:3000.
-
-4. Once you have reviewed your changes, follow the instructions at `{geode-project-dir}/geode-site/website/README.md`
for propagating changes to the `asf-site` branch.
+3. Follow the instructions at `{geode-project-dir}/geode-site/website/README.md` to build,
review, and publish the Apache Geode website.

http://git-wip-us.apache.org/repos/asf/geode/blob/b8adff23/geode-site/website/README.md
----------------------------------------------------------------------
diff --git a/geode-site/website/README.md b/geode-site/website/README.md
index 56b6aeb..11da1b2f 100644
--- a/geode-site/website/README.md
+++ b/geode-site/website/README.md
@@ -6,7 +6,7 @@ Source files for the website are in `${geode-project-dir}/geode-site/website/con
 
 Generated files for the website are in `${geode-project-dir}/geode-site/content`.
 
-NOTE: To make changes to the [Apache Geode User Guide](http://geode.apache.org/docs/guide/About_Geode.html):
+**NOTE:** To make changes to the [Apache Geode User Guide](http://geode.apache.org/docs/),
which is published to the website:
 
 - See `${geode-project-dir}/geode-docs/CONTRIBUTE.md` for information about contributing
to the documentation source files.
 - See `${geode-project-dir}/geode-book/README.md` for information about building a local
version of the guide and adding it to the website.
@@ -48,7 +48,7 @@ If you need to change the layout or styling of the site,
 then you will probably need to change an HTML, JS or CSS file 
 within the ``${geode-project-dir}/geode-site/website/content`` directory.
 
-NOTE: The [Apache Geode User Guide](http://geode.apache.org/docs/guide/About_Geode.html)
source files are in `${geode-project-dir}/geode-docs/`. See `${geode-project-dir}/geode-docs/CONTRIBUTE.md`
for more information.
+**NOTE:** The [Apache Geode User Guide](http://geode.apache.org/docs/guide/About_Geode.html)
source files are in `${geode-project-dir}/geode-docs/`. See `${geode-project-dir}/geode-docs/CONTRIBUTE.md`
for more information.
 
 ### 2. Locally generate the site and test your changes
 
@@ -63,8 +63,6 @@ With a cwd of ``${geode-project-dir}/geode-site/website``:
 Run ``git status`` and you should see your changes plus any updated files
 under the ``${geode-project-dir}/content`` directory.
 
-NOTE: Whether or not you have made changes to the Apache Geode User Guide, you must now build
the User Guide and move the User Guide files to the Geode website. For instructions, see `${geode-project-dir}/geode-book/README.md`.
-
 To view your changes locally, use the view command to start a local web server. Check the
website at [http://0.0.0.0:3000](http://0.0.0.0:3000)
 
     $ nanoc view


Mime
View raw message