Skip to content

Commit

Permalink
[FAB-6083] Improves doc for Windows platform
Browse files Browse the repository at this point in the history
This change clarifies what is required on Windows to be able
to successfully run the curl command to download the platform
specific binaries.
It also fixes a couple of broken links in the doc.

Change-Id: Icb4de658411f4afe53791f1cbddb65ce4cdf2372
Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
  • Loading branch information
lehors committed Nov 29, 2017
1 parent 750c139 commit 8799f9c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/source/chaincode4ade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ Download Docker images

We need four Docker images in order for "dev mode" to run against the supplied
docker compose script. If you installed the ``fabric-samples`` repo clone and
followed the instructions to :ref:`download-platform-specific-binaries`, then
followed the instructions to :ref:`binaries`, then
you should have the necessary Docker images installed locally.

.. note:: If you choose to manually pull the images then you must retag them as
Expand All @@ -436,7 +436,7 @@ should see something similar to following:
hyperledger/fabric-ccenv latest 4b70698a71d3 4 hours ago 1.29 GB
hyperledger/fabric-ccenv x86_64-1.0.0 4b70698a71d3 4 hours ago 1.29 GB
.. note:: If you retrieved the images through the :ref:`download-platform-specific-binaries`,
.. note:: If you retrieved the images through the :ref:`binaries`,
then you will see additional images listed. However, we are only concerned with
these four.

Expand Down
20 changes: 13 additions & 7 deletions docs/source/prereqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Docker and Docker Compose
You will need the following installed on the platform on which you will be
operating, or developing on (or for), Hyperledger Fabric:

- MacOSX, *nix, or Windows 10: `Docker <https://www.docker.com/products/overview>`__
- MacOSX, \*nix, or Windows 10: `Docker <https://www.docker.com/products/overview>`__
Docker version 17.06.2-ce or greater is required.
- Older versions of Windows: `Docker
Toolbox <https://docs.docker.com/toolbox/toolbox_install_windows/>`__ -
Expand Down Expand Up @@ -117,16 +117,22 @@ Check your version(s):
Windows extras
--------------

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 <https://git-scm.com/downloads>`__
which you typically get as part of installing Docker Toolbox on
Windows 7.
If you are developing on Windows 7, you will want to work within the
Docker Quickstart Terminal which uses `Git Bash
<https://git-scm.com/downloads>`__ and provides a better alternative
to the built-in Windows shell.

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.
difficulties with operations involving the ``make`` and ``docker``
commands.

On Windows 10 you should use the native Docker distribution and you
may use the Windows PowerShell. However, for the :ref:`binaries`
command to succeed you will still need to have the ``uname`` command
available. You can get it as part of Git but beware that only the
64bit version is supported.

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

Expand Down
15 changes: 9 additions & 6 deletions docs/source/samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,20 @@ you will extract the platform-specific binaries:
curl -sSL https://goo.gl/6wtTN5 | bash -s 1.1.0-preview
.. note:: If you get an error running the above curl command, you may
have too old a version of curl that does not handle redirects.
Please visit the :doc:`prereqs` page for additional information on
where to find the latest version. Alternately, you can substitute the
un-shortened URL:
https://github.com/hyperledger/fabric/blob/master/scripts/bootstrap.sh
have too old a version of curl that does not handle
redirects or an unsupported environment.

Please visit the :doc:`prereqs` page for additional
information on where to find the latest version of curl and
get the right environment. Alternately, you can substitute
the un-shortened URL:
https://github.com/hyperledger/fabric/blob/master/scripts/bootstrap.sh

.. note:: You can use the command above for any published version of Hyperledger
Fabric. Simply replace '1.1.0-preview' with the version identifier
of the version you wish to install.

The curl command above downloads and executes a bash script
The 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:
Expand Down

0 comments on commit 8799f9c

Please sign in to comment.