Skip to content

Commit 1b6820a

Browse files
committed
[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 <[email protected]>
1 parent dda9ddc commit 1b6820a

File tree

2 files changed

+31
-14
lines changed

2 files changed

+31
-14
lines changed

docs/source/prereqs.rst

+24-13
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ Prerequisites
44
Install cURL
55
------------
66

7-
Download the `cURL <https://curl.haxx.se/download.html>`__ tool if not
8-
already installed.
7+
Download the latest version of the `cURL
8+
<https://curl.haxx.se/download.html>`__ tool if it is not already
9+
installed or if you get errors running the curl commands from the
10+
documentation.
911

1012
.. note:: If you're on Windows please see the specific note on `Windows
1113
extras`_ below.
@@ -59,6 +61,7 @@ source code is located somewhere within the ``$GOPATH`` tree. First, you will
5961
need to check that you have set your ``$GOPATH`` environment variable.
6062

6163
.. code:: bash
64+
6265
echo $GOPATH
6366
/Users/xxx/go
6467
@@ -95,18 +98,16 @@ installed.
9598
Windows extras
9699
--------------
97100

98-
If you are developing on Windows, you may also need the following which
99-
provides a better alternative to the built-in Windows tools:
100-
101-
- `Git Bash <https://git-scm.com/downloads>`__
101+
If you are developing on Windows, you will want to work within the
102+
Docker Quickstart Terminal which provides a better alternative to the
103+
built-in Windows such as `Git Bash <https://git-scm.com/downloads>`__
104+
which you typically get as part of installing Docker Toolbox on
105+
Windows 7.
102106

103-
.. note:: On older versions of Windows, such as Windows 7, you
104-
typically get this as part of installing Docker
105-
Toolbox. However experience has shown this to be a poor
106-
development environment with limited functionality. It is
107-
suitable to run Docker based scenarios, such as
108-
:doc:`getting_started`, but you may not be able to find a
109-
suitable ``make`` command.
107+
However experience has shown this to be a poor development environment
108+
with limited functionality. It is suitable to run Docker based
109+
scenarios, such as :doc:`getting_started`, but you may have
110+
difficulties with operations involving the ``make`` command.
110111

111112
Before running any ``git clone`` commands, run the following commands:
112113

@@ -141,6 +142,16 @@ See the `NPM windows-build-tools page
141142
<https://www.npmjs.com/package/windows-build-tools>`__ for more
142143
details.
143144

145+
Once this is done, you should also install the NPM GRPC module with the
146+
following command:
147+
148+
.. code:: bash
149+
150+
npm install --global grpc
151+
152+
Your environment should now be ready to go through the
153+
:doc:`getting_started` samples and tutorials.
154+
144155
.. note:: If you have questions not addressed by this documentation, or run into
145156
issues with any of the tutorials, please visit the :doc:`questions`
146157
page for some tips on where to find additional help.

docs/source/samples.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Hyperledger Fabric Samples
22
==========================
33

44
.. note:: If you are running on **Windows** you will want to make use of the
5-
``Git bash shell`` extension for the upcoming terminal commands.
5+
Docker Quickstart Terminal for the upcoming terminal commands.
66
Please visit the :doc:`prereqs` if you haven't previously installed
77
it.
88

@@ -46,10 +46,16 @@ you will extract the platform-specific binaries:
4646
4747
curl -sSL https://goo.gl/iX9dek | bash
4848
49+
.. note:: If you get an error running the above curl command, you may
50+
have too old a version of curl. Please visit the
51+
:doc:`prereqs` page for additional information on where to
52+
find the latest version.
53+
4954
The curl command above downloads and executes a bash script
5055
that will download and extract all of the platform-specific binaries you
5156
will need to set up your network and place them into the cloned repo you
5257
created above. It retrieves four platform-specific binaries:
58+
5359
* ``cryptogen``,
5460
* ``configtxgen``,
5561
* ``configtxlator``, and

0 commit comments

Comments
 (0)