Skip to content

Commit 42ca84b

Browse files
committed
FAB-506 broken links fixes and added new targets
fixed broken links and added new targets (Releases, Fabric Starter kit & SystemChaincode) in mkdocs.yml. Also fixed some formatting errors in fabric-starter-kit.md Change-Id: Ia5736bd258ef3bd2e1bb6575af605da35f62ea0a Signed-off-by: rameshthoomu <[email protected]>
1 parent dd5cef6 commit 42ca84b

File tree

4 files changed

+57
-47
lines changed

4 files changed

+57
-47
lines changed

docs/API/CoreAPI.md

+23-16
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ This document covers the available APIs for interacting with a peer node. Three
77
1. [CLI](#cli)
88
2. [REST API](#rest-api)
99
3. [Node.js Application](#nodejs-application)
10-
* [Using Swagger JS Plugin](#using-swagger-js-plugin)
11-
* [Marbles Demo Application](#marbles-demo-application)
12-
* [Commercial Paper Demo Application](#commercial-paper-demo-application)
10+
* [Using Swagger JS Plugin](#using-swagger-js-plugin)
11+
* [Marbles Demo Application](#marbles-demo-application)
12+
* [Commercial Paper Demo Application](#commercial-paper-demo-application)
1313

1414
**Note:** If you are working with APIs with security enabled, please review the [security setup instructions](https://github.com/hyperledger/fabric/blob/master/docs/Setup/Chaincode-setup.md#security-setup-optional) before proceeding.
1515

@@ -68,21 +68,28 @@ Command | **stdout** result in the event of success
6868

6969
Deploy creates the docker image for the chaincode and subsequently deploys the package to the validating peer. An example is below.
7070

71-
`peer chaincode deploy -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Function":"init", "Args": ["a","100", "b", "200"]}'`
72-
71+
```
72+
peer chaincode deploy -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Function":"init", "Args": ["a","100", "b", "200"]}'
73+
```
7374
Or:
7475

75-
`peer chaincode deploy -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args": ["init", "a","100", "b", "200"]}'`
76+
```
77+
peer chaincode deploy -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args": ["init", "a","100", "b", "200"]}'
78+
```
7679

7780
The response to the chaincode deploy command will contain the chaincode identifier (hash) which will be required on subsequent `chaincode invoke` and `chaincode query` commands in order to identify the deployed chaincode.
7881

7982
With security enabled, modify the command to include the -u parameter passing the username of a logged in user as follows:
8083

81-
`peer chaincode deploy -u jim -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Function":"init", "Args": ["a","100", "b", "200"]}'`
84+
```
85+
peer chaincode deploy -u jim -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Function":"init", "Args": ["a","100", "b", "200"]}'
86+
```
8287

8388
Or:
8489

85-
`peer chaincode deploy -u jim -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args": ["init", "a","100", "b", "200"]}'`
90+
```
91+
peer chaincode deploy -u jim -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args": ["init", "a","100", "b", "200"]}'
92+
```
8693

8794
**Note:** If your GOPATH environment variable contains more than one element, the chaincode must be found in the first one or deployment will fail.
8895

@@ -165,19 +172,19 @@ You can work with the REST API through any tool of your choice. For example, the
165172
To learn about the REST API through Swagger, please take a look at the Swagger document [here](https://github.com/hyperledger/fabric/blob/master/core/rest/rest_api.json). You can upload the service description file to the Swagger service directly or, if you prefer, you can set up Swagger locally by following the instructions [here](#to-set-up-swagger-ui).
166173

167174
* [Block](#block)
168-
* GET /chain/blocks/{Block}
175+
* GET /chain/blocks/{Block}
169176
* [Blockchain](#blockchain)
170-
* GET /chain
177+
* GET /chain
171178
* [Chaincode](#chaincode)
172179
* POST /chaincode
173180
* [Network](#network)
174-
* GET /network/peers
181+
* GET /network/peers
175182
* [Registrar](#registrar)
176-
* POST /registrar
177-
* DELETE /registrar/{enrollmentID}
178-
* GET /registrar/{enrollmentID}
179-
* GET /registrar/{enrollmentID}/ecert
180-
* GET /registrar/{enrollmentID}/tcert
183+
* POST /registrar
184+
* DELETE /registrar/{enrollmentID}
185+
* GET /registrar/{enrollmentID}
186+
* GET /registrar/{enrollmentID}/ecert
187+
* GET /registrar/{enrollmentID}/tcert
181188
* [Transactions](#transactions)
182189
* GET /transactions/{UUID}
183190

docs/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ v0.6-preview.
2727

2828
If you'd like to dive right in and get an operational experience on your local
2929
server or laptop to begin development, we have just the thing for you. We have
30-
created a standalone Docker-based [starter kit](Starter/fabric-starter-kit.md)
30+
created a standalone Docker-based [starter kit](starter/fabric-starter-kit.md)
3131
that leverages the latest published Docker images that you can run on your
3232
laptop and be up and running in no time. That should get you going with a
3333
sample application and some simple chaincode. From there, you can go deeper
@@ -122,14 +122,14 @@ testing Chaincode.
122122
relating to Chaincode.
123123

124124
## Application developer guide
125-
125+
```
126126
- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
127127
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
128128
- [REST](API/CoreAPI.md#rest-api): working with the REST API (*deprecated*).
129129
- [Node.js SDK](nodeSDK/node-sdk-guide.md): working with the Node.js SDK.
130-
130+
```
131131
## Fabric developer guide
132-
132+
```
133133
- [Making code contributions](CONTRIBUTING.md): First, you'll want to familiarize
134134
yourself with the project's contribution guidelines.
135135
- [Setting up the development environment](dev-setup/devenv.md): after that, you
@@ -145,16 +145,16 @@ relating to Chaincode.
145145
- [License header](dev-setup/headers.txt): every source file must include this
146146
license header modified to include a copyright statement for the principle
147147
author(s).
148-
148+
```
149149
# Operations guide
150-
150+
```
151151
- [Setting Up a Network](Setup/Network-setup.md): instructions for setting up a
152152
network of fabric peers.
153153
- [Certificate Authority (CA) Setup](Setup/ca-setup.md): setting up a CA to
154154
support identity, security (authentication/authorization), privacy and
155155
confidentiality.
156156
- [Application ACL](tech/application-ACL.md): working with access control lists.
157-
157+
```
158158
# License <a name="license"></a>
159159
The Hyperledger Project uses the [Apache License Version 2.0](LICENSE) software
160160
license.

docs/starter/fabric-starter-kit.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the fabric's Node.js SDK, and chaincode written in Go.
99
There are three Docker images that, when run, will provide a basic
1010
network environment. There is an image to run a single `peer`, one to run
1111
the `membersrvc` and one to run both your Node.js application and the your
12-
chaincode. See [Application Developer's Overview](app-overview.md) on how the
12+
chaincode. See [Application Developer's Overview](../nodeSDK/app-overview.md) on how the
1313
components running within the containers will communicate.
1414

1515
The starter kit comes with a sample Node.js application ready to execute and
@@ -28,9 +28,9 @@ Hyperledger fabric.* We recommend first running in chaincode development mode.
2828
## Further exploration
2929

3030
If you wish, there are a number of chaincode examples near by.
31-
32-
`cd ../../chaincode`
33-
31+
```
32+
cd ../../chaincode
33+
```
3434
## Getting started
3535

3636
**Note:** This sample was prepared using Docker for Mac 1.12.0
@@ -63,36 +63,35 @@ is located, execute one of following `docker-compose` commands.
6363

6464
* to run as detached containers:
6565

66-
```
67-
docker-compose up -d
68-
```
66+
```
67+
docker-compose up -d
68+
```
6969
**note:** to see the logs for the `peer` container use the
7070
`docker logs peer` command
7171

7272
* to run in the foreground and see the log output in the current terminal
7373
session:
7474

75-
```
76-
docker-compose up
77-
```
75+
```
76+
docker-compose up
77+
```
7878

7979
Both commands will start three docker containers, to view the container
8080
status try `docker ps` command. The first time this is run the Docker
8181
images will be downloaded. This may take 10 minutes or more depending on the
8282
network connections of the system running the command.
8383

84-
```
85-
docker ps
86-
```
87-
88-
You should see something like the following:
84+
```
85+
docker ps
86+
```
87+
You should see something like the following:
8988

90-
```
91-
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
92-
bb01a2fa96ef hyperledger/fabric-starter-kit "sh -c 'sleep 20; /op" About a minute ago Up 59 seconds starter
93-
ec7572e65f12 hyperledger/fabric-peer "sh -c 'sleep 10; pee" About a minute ago Up About a minute peer
94-
118ef6da1709 hyperledger/fabric-membersrvc "membersrvc" About a minute ago Up About a minute membersrvc
95-
```
89+
```
90+
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
91+
bb01a2fa96ef hyperledger/fabric-starter-kit "sh -c 'sleep 20; /op" About a minute ago Up 59 seconds starter
92+
ec7572e65f12 hyperledger/fabric-peer "sh -c 'sleep 10; pee" About a minute ago Up About a minute peer
93+
118ef6da1709 hyperledger/fabric-membersrvc "membersrvc" About a minute ago Up About a minute membersrvc
94+
```
9695

9796
* Start a terminal session in the **starter** container. This is where the
9897
Node.js application is located.

mkdocs.yml

+7-3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ pages:
1111
- Glossary: glossary.md
1212
- Protocol Spec: protocol-spec.md
1313
- Usecases: biz/usecases.md
14+
- System Chaincode: SystemChaincode-noop.md
1415

1516
- Installation and setup:
1617
- Chaincode or Application Developer Setup: Setup/Chaincode-setup.md
@@ -24,7 +25,6 @@ pages:
2425
- Chaincode APIs: API/ChaincodeAPI.md
2526
- Core API: API/CoreAPI.md
2627
- CA API: API/MemberServicesAPI.md
27-
- System Chaincode: SystemChaincodes/noop.md
2828

2929
- Fabric Developer:
3030
- v1.0 Preview: abstract_v1.md
@@ -37,7 +37,7 @@ pages:
3737
- Maintainers: MAINTAINERS.md
3838
- Reviewing: Gerrit/reviewing.md
3939
- Changes: Gerrit/changes.md
40-
- Style guides:
40+
- Style guides:
4141
- Golang: Style-guides/go-style.md
4242

4343
- FAQ:
@@ -57,10 +57,14 @@ pages:
5757
- App-Overview: nodeSDK/app-overview.md
5858
- Node-SDK-guide: nodeSDK/node-sdk-guide.md
5959
- Node-SDK-indepth: nodeSDK/node-sdk-indepth.md
60-
- Node-SDK-self-contained: nodeSDK/node-sdk-self-contained.md
6160
- Sample-Standalone-app: nodeSDK/sample-standalone-app.md
6261
- Sample-web-app: nodeSDK/sample-web-app.md
6362

63+
- Starter Kit:
64+
- Starter Kit: starter/fabric-starter-kit.md
65+
66+
- Releases: releases.md
67+
6468
markdown_extensions:
6569
- extra
6670
- tables

0 commit comments

Comments
 (0)