Skip to content

Commit

Permalink
[FAB-3229] dead links in Building the fabric page
Browse files Browse the repository at this point in the history
Fixed [FAB-3229] by:
* using :doc: references and removing .md
* correcting tag names
* correcting external links
minor fixes to make these links work
[ci-skip]

Change-Id: I12946e08b774183a3d5f2a068e52fdf25187b125
Signed-off-by: Tracy Kuhrt <tkuhrt@linuxfoundation.org>
Signed-off-by: Nick Gaski <ngaski@us.ibm.com>
  • Loading branch information
tkuhrt authored and nickgaski committed Apr 21, 2017
1 parent 441b308 commit 72e5122
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
14 changes: 6 additions & 8 deletions docs/source/dev-setup/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Building the fabric
-------------------

The following instructions assume that you have already set up your
`development environment <devenv.md>`__.
:doc:`development environment <devenv>`.

To build the Fabric:

Expand Down Expand Up @@ -37,15 +37,14 @@ Running Node.js Unit Tests
You must also run the Node.js unit tests to insure that the Node.js
client SDK is not broken by your changes. To run the Node.js unit tests,
follow the instructions
`here <https://github.com/hyperledger/fabric-sdk-node/README.md>`__.
`here <https://github.com/hyperledger/fabric-sdk-node/blob/master/README.md>`__.

Running Behave BDD Tests
~~~~~~~~~~~~~~~~~~~~~~~~

**Note:** currently, the behave tests must be run from within in the
Vagrant environment. See the devenv setup instructions if you have not
already set up your `Vagrant
environment <devenv.md#Boostrapping-the-VM-using-Vagrant>`__.
Vagrant environment. See the :doc:`development environment <devenv>` setup instructions
if you have not already set up your Vagrant environment.

`Behave <http://pythonhosted.org/behave/>`__ tests will setup networks
of peers with different security and consensus configurations and verify
Expand Down Expand Up @@ -108,7 +107,7 @@ Building on Power Platform
~~~~~~~~~~~~~~~~~~~~~~~~~~

Development and build on Power (ppc64le) systems is done outside of
vagrant as outlined `here <#building-outside-of-vagrant->`__. For ease
vagrant as outlined `here <#building-outside-of-vagrant>`__. For ease
of setting up the dev environment on Ubuntu, invoke `this
script <https://github.com/hyperledger/fabric/tree/master/devenv/setupUbuntuOnPPC64le.sh>`__
as root. This script has been validated on Ubuntu 16.04 and assumes
Expand Down Expand Up @@ -154,6 +153,5 @@ library.
The available log levels in order of increasing verbosity are: *CRITICAL
\| ERROR \| WARNING \| NOTICE \| INFO \| DEBUG*

See `specific logging
control <https://github.com/hyperledger/fabric/blob/master/docs/Setup/logging-control.md>`__
See :doc:`specific logging control <../Setup/logging-control>`
instructions when running the peer process.
10 changes: 5 additions & 5 deletions docs/source/dev-setup/devenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,18 @@ little bit of setup needed:

Recall that we are using ``Gerrit`` for source control, which has its
own internal git repositories. Hence, we will need to clone from
`Gerrit <../Gerrit/gerrit.md#Working-with-a-local-clone-of-the-repository>`__.
:doc:`Gerrit <../Gerrit/gerrit>`.
For brevity, the command is as follows:

::

git clone ssh://LFID@gerrit.hyperledger.org:29418/fabric && scp -p -P 29418 LFID@gerrit.hyperledger.org:hooks/commit-msg fabric/.git/hooks/

**Note:** Of course, you would want to replace ``LFID`` with your own
`Linux Foundation ID <../Gerrit/lf-account.md>`__.
:doc:`Linux Foundation ID <../Gerrit/lf-account>`.

Boostrapping the VM using Vagrant
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Bootstrapping the VM using Vagrant
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you are planning on using the Vagrant developer environment, the
following steps apply. **Again, we recommend against its use except for
Expand All @@ -147,7 +147,7 @@ Building the fabric
~~~~~~~~~~~~~~~~~~~

Once you have all the dependencies installed, and have cloned the
repository, you can proceed to `build and test <build.md>`__ the fabric.
repository, you can proceed to :doc:`build and test <build>` the fabric.

Notes
~~~~~
Expand Down

0 comments on commit 72e5122

Please sign in to comment.