Skip to content

Commit 5124056

Browse files
committed
Fixed broken anchors in the documentation.
Links in the docs now redirect to the correct senction when clicked. Added more links in the table of contents of the protocol specification doc. Improved the coherence of the headers assignation of the protocol specification doc ('##' for main sections and adding a '#' for any inner subsection). Change-Id: Ie5b4a424fd661b346dce9e93bb773a2c5bc628f3 Signed-off-by: Ivan Puddu <[email protected]>
1 parent 1be487d commit 5124056

File tree

3 files changed

+226
-209
lines changed

3 files changed

+226
-209
lines changed

docs/Setup/Chaincode-setup.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The following instructions apply to _developing_ chaincode in Go or Java. They d
1010

1111
Once again, you have the choice of using one of the following approaches:
1212

13-
- [Option 1](#Option-1-Vagrant-development-environment) using the **Vagrant** [development environment](https://github.com/hyperledger/fabric/blob/master/docs/dev-setup/devenv.md) that is used for developing the fabric itself
14-
- [Option 2](#Option-2-Docker-for-Mac-or-Windows) using Docker for Mac or Windows
15-
- [Option 3](#Option-3-Docker-Toolbox) using Docker toolbox
13+
- [Option 1](#option-1-vagrant-development-environment) using the **Vagrant** [development environment](https://github.com/hyperledger/fabric/blob/master/docs/dev-setup/devenv.md) that is used for developing the fabric itself
14+
- [Option 2](#option-2-docker-for-mac-or-windows) using Docker for Mac or Windows
15+
- [Option 3](#option-3-docker-toolbox) using Docker toolbox
1616

1717
By using options *2* or *3*, above, you avoid having to build everything from scratch, and there's no need to keep a clone of the fabric GitHub repos current/up-to-date. Instead, you can simply pull and run the `fabric-peer` and `fabric-membersrvc` images directly from DockerHub.
1818

@@ -67,7 +67,7 @@ Now, you are ready to start [running the chaincode](#running-the-chaincode).
6767

6868
## Option 2 Docker for Mac or Windows
6969

70-
If you would prefer to simply run the fabric components as built and published by the Hyperledger project on your Mac or Windows laptop/server using the Docker for [Mac](https://docs.docker.com/engine/installation/mac/) or [Windows](https://docs.docker.com/engine/installation/windows/) platform, following these steps. If using [Docker Toolbox](https://docs.docker.com/toolbox/overview/), please skip to [Option 3](#Option-3-Docker-Toolbox), below.
70+
If you would prefer to simply run the fabric components as built and published by the Hyperledger project on your Mac or Windows laptop/server using the Docker for [Mac](https://docs.docker.com/engine/installation/mac/) or [Windows](https://docs.docker.com/engine/installation/windows/) platform, following these steps. If using [Docker Toolbox](https://docs.docker.com/toolbox/overview/), please skip to [Option 3](#option-3-docker-toolbox), below.
7171

7272
### Pull images from DockerHub
7373

@@ -152,14 +152,14 @@ Start a **new** terminal window.
152152

153153
### Vagrant
154154

155-
If you are using [Option 1](#Option-1-Vagrant-development-environment), you'll need to `ssh` to Vagrant. Otherwise, [skip](#Not-Vagrant) this step.
155+
If you are using [Option 1](#option-1-vagrant-development-environment), you'll need to `ssh` to Vagrant. Otherwise, [skip](#not-vagrant) this step.
156156

157157
```
158158
cd $GOPATH/src/github.com/hyperledger/fabric/devenv
159159
vagrant ssh
160160
```
161161

162-
Next, we'll build the **chaincode_example02** code, which is provided in the Hyperledger fabric source code repository. If you are using [Option 1](#Option-1-Vagrant-development-environment), then you can do this from your clone of the fabric repository.
162+
Next, we'll build the **chaincode_example02** code, which is provided in the Hyperledger fabric source code repository. If you are using [Option 1](#option-1-vagrant-development-environment), then you can do this from your clone of the fabric repository.
163163

164164
```
165165
cd $GOPATH/src/github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02
@@ -168,7 +168,7 @@ go build
168168

169169
### Not Vagrant
170170

171-
If you are using either [Option 2](#Option-2-Docker-for-Mac-or-Windows) or [Option 3](#Option-3-Docker-Toolbox), you'll need to download the sample chaincode. The chaincode project must be placed somewhere under the `src` directory in your local `$GOPATH` as shown below.
171+
If you are using either [Option 2](#option-2-docker-for-mac-or-windows) or [Option 3](#option-3-docker-toolbox), you'll need to download the sample chaincode. The chaincode project must be placed somewhere under the `src` directory in your local `$GOPATH` as shown below.
172172

173173
```
174174
mkdir -p $GOPATH/src/github.com/chaincode_example02/

docs/Setup/Network-setup.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Setting Up a Network
22

3-
This document covers setting up a network on your local machine for various development and testing activities. Unless you are intending to contribute to the development of the Hyperledger Fabric project, you'll probably want to follow the more commonly used approach below - [leveraging published Docker images](#leveraging-published Docker-images) for the various Hyperledger Fabric components, directly. Otherwise, skip down to the [secondary approach](#building-your-own-images) below.
3+
This document covers setting up a network on your local machine for various development and testing activities. Unless you are intending to contribute to the development of the Hyperledger Fabric project, you'll probably want to follow the more commonly used approach below - [leveraging published Docker images](#leveraging-published-docker-images) for the various Hyperledger Fabric components, directly. Otherwise, skip down to the [secondary approach](#building-your-own-images) below.
44

55
### Leveraging published Docker images
66

@@ -24,7 +24,7 @@ prior to starting any of the fabric components, you will need to first pull the
2424

2525
### Building your own images
2626

27-
**Note:** _This approach is not necessarily recommended for most users_. If you have pulled images from DockerHub as described in the previous section, you may proceed to the [next step](#Starting-up-validating-peers).
27+
**Note:** _This approach is not necessarily recommended for most users_. If you have pulled images from DockerHub as described in the previous section, you may proceed to the [next step](#starting-up-validating-peers).
2828

2929
The second approach would be to leverage the [development environment](../dev-setup/devenv.md) setup (which we will assume you have already established) to build and deploy your own binaries and/or Docker images from a clone of the [hyperledger/fabric](https://github.com/hyperledger/fabric) GitHub repository. This approach is suitable for developers that might wish to contribute directly to the Hyperledger Fabric project, or that wish to deploy from a fork of the Hyperledger code base.
3030

@@ -137,11 +137,11 @@ This single peer configuration, running the `NOOPS` 'consensus' plugin, should s
137137

138138
#### Running with the CA
139139

140-
If you want to take advantage of security (authentication and authorization), privacy and confidentiality, then you'll need to run the Fabric's certificate authority (CA). Please refer to the [CA Setup](#Setup/ca-setup.md) instructions.
140+
If you want to take advantage of security (authentication and authorization), privacy and confidentiality, then you'll need to run the Fabric's certificate authority (CA). Please refer to the [CA Setup](ca-setup.md) instructions.
141141

142142
#### Start up additional validating peers:
143143

144-
Following the pattern we established [above](#Assigning-a-value-for-CORE_PEER_ID) we'll use `vp1` as the ID for the second validating peer. If using Docker Compose, we can simply link the two peer nodes.
144+
Following the pattern we established [above](#assigning-a-value-for-core_peer_id) we'll use `vp1` as the ID for the second validating peer. If using Docker Compose, we can simply link the two peer nodes.
145145
Here's the docker-compse.yml for a **Vagrant** environment with two peer nodes - vp0 and vp1:
146146
```
147147
vp0:

0 commit comments

Comments
 (0)