From 1b6820a2cc22164fb8f681097faec9db8632ee5e Mon Sep 17 00:00:00 2001 From: Arnaud J Le Hors Date: Wed, 26 Jul 2017 11:14:31 -0700 Subject: [PATCH] [FAB-5484] Fixes documentation for Windows users With this change the documentation instructs Windows users to work within the Docker Quickstart Terminal rather than Git Bash which does not work for Windows 10. This change also adds a note to the first curl command to address the recurrent problem with Windows users reporting failure due to using an outdated version of curl. Patch-set #2: added a piece about installing npm grpc based on users reporting this was necessary. Change-Id: I95e7caeddc43e48f107955018aced112893ca540 Signed-off-by: Arnaud J Le Hors --- docs/source/prereqs.rst | 37 ++++++++++++++++++++++++------------- docs/source/samples.rst | 8 +++++++- 2 files changed, 31 insertions(+), 14 deletions(-) diff --git a/docs/source/prereqs.rst b/docs/source/prereqs.rst index 40800e32535..77b1eb8101c 100644 --- a/docs/source/prereqs.rst +++ b/docs/source/prereqs.rst @@ -4,8 +4,10 @@ Prerequisites Install cURL ------------ -Download the `cURL `__ tool if not -already installed. +Download the latest version of the `cURL +`__ tool if it is not already +installed or if you get errors running the curl commands from the +documentation. .. note:: If you're on Windows please see the specific note on `Windows extras`_ below. @@ -59,6 +61,7 @@ source code is located somewhere within the ``$GOPATH`` tree. First, you will need to check that you have set your ``$GOPATH`` environment variable. .. code:: bash + echo $GOPATH /Users/xxx/go @@ -95,18 +98,16 @@ installed. Windows extras -------------- -If you are developing on Windows, you may also need the following which -provides a better alternative to the built-in Windows tools: - - - `Git Bash `__ +If you are developing on Windows, you will want to work within the +Docker Quickstart Terminal which provides a better alternative to the +built-in Windows such as `Git Bash `__ +which you typically get as part of installing Docker Toolbox on +Windows 7. -.. note:: On older versions of Windows, such as Windows 7, you - typically get this as part of installing Docker - Toolbox. However experience has shown this to be a poor - development environment with limited functionality. It is - suitable to run Docker based scenarios, such as - :doc:`getting_started`, but you may not be able to find a - suitable ``make`` command. +However experience has shown this to be a poor development environment +with limited functionality. It is suitable to run Docker based +scenarios, such as :doc:`getting_started`, but you may have +difficulties with operations involving the ``make`` command. Before running any ``git clone`` commands, run the following commands: @@ -141,6 +142,16 @@ See the `NPM windows-build-tools page `__ for more details. +Once this is done, you should also install the NPM GRPC module with the +following command: + +.. code:: bash + + npm install --global grpc + +Your environment should now be ready to go through the +:doc:`getting_started` samples and tutorials. + .. note:: If you have questions not addressed by this documentation, or run into issues with any of the tutorials, please visit the :doc:`questions` page for some tips on where to find additional help. diff --git a/docs/source/samples.rst b/docs/source/samples.rst index 469767bace1..965dd1dfd47 100644 --- a/docs/source/samples.rst +++ b/docs/source/samples.rst @@ -2,7 +2,7 @@ Hyperledger Fabric Samples ========================== .. note:: If you are running on **Windows** you will want to make use of the - ``Git bash shell`` extension for the upcoming terminal commands. + Docker Quickstart Terminal for the upcoming terminal commands. Please visit the :doc:`prereqs` if you haven't previously installed it. @@ -46,10 +46,16 @@ you will extract the platform-specific binaries: curl -sSL https://goo.gl/iX9dek | bash +.. note:: If you get an error running the above curl command, you may + have too old a version of curl. Please visit the + :doc:`prereqs` page for additional information on where to + find the latest version. + The curl command above downloads and executes a bash script that will download and extract all of the platform-specific binaries you will need to set up your network and place them into the cloned repo you created above. It retrieves four platform-specific binaries: + * ``cryptogen``, * ``configtxgen``, * ``configtxlator``, and