FAB-5034 provide clearer directions

provide clearer directions to simply download binaries and Docker images Change-Id: Ib6c6622ea9bf6025bfbd78ba8c10c70f23ca160b Signed-off-by: Christopher Ferris <[email protected]>
IndustriaTech · Jun 29, 2017 · 3c3cd03 · 3c3cd03
1 parent dc7c40b
commit 3c3cd03
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -9,6 +9,12 @@ you have all the :doc:`prereqs` installed on the platform(s)
 on which you'll be developing blockchain applications and/or operating
 Hyperledger Fabric.
 
+Install Binaries and Docker Images
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+While we work on developing real installers for the Hyperledger Fabric
+binaries, we provide a script that will :ref:`binaries` to your system.
+The script also will download the Docker images to your local registry.
+
 Hyperledger Fabric Samples
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/source/samples.rst b/docs/source/samples.rst
@@ -28,11 +28,19 @@ execute the following commands:
   git clone https://github.com/hyperledger/fabric-samples.git
   cd fabric-samples
 
+.. _binaries:
+
 Download Platform-specific Binaries
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Next, we will install the Hyperledger Fabric platform-specific binaries.
-To do this, execute the following command:
+This process was designed to complement the Hyperledger Fabric Samples
+above, but can be used independently. If you are not installing the
+samples above, then simply create and enter a directory into which to
+extract the contents of the platform-specific binaries.
+
+Please execute the following command from within the directory into which
+you will extract the platform-specific binaries:
 
 .. code:: bash
 
@@ -47,14 +55,15 @@ created above. It retrieves four platform-specific binaries:
   * ``configtxlator``, and
   * ``peer``
 
-and places them in the ``fabric-samples/bin`` directory.
+and places them in the ``bin`` sub-directory of the current working
+directory.
 
 You may want to add that to your PATH environment variable so that these
 can be picked up without fully qualifying the path to each binary. e.g.:
 
 .. code:: bash
 
-  export PATH=<path to fabric-samples>/bin:$PATH
+  export PATH=<path to download location>/bin:$PATH
 
 Finally, the script will download the Hyperledger Fabric docker images from
 `DockerHub <https://hub.docker.com/u/hyperledger/>`__ into