Skip to content

Commit c8205c6

Browse files
committed
FAB-598: fixed nodesdk doc broken links
fixed nodesdk doc broken links and added permalinks and admonition in mkdocs.yml file. These changes improves user experience while using documentation through readthedocs. Change-Id: Ic24782898c70732c99565c72487973c8fbce8704 Signed-off-by: rameshthoomu <[email protected]>
1 parent e728c5c commit c8205c6

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

docs/Setup/NodeSDK-setup.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,4 @@ See [Hyperledger fabric Node.js client SDK](../nodeSDK/node-sdk-guide.md) for mo
2424
## Hyperledger fabric network
2525

2626
First, you'll want to have a running peer node and member services. The
27-
instructions for setting up a network are
28-
[here](Network-setup.md). You may also use the [self contained environment](../nodeSDK/node-sdk-self-contained.md) that provides the network.
27+
instructions for setting up a network are [here](Network-setup.md). You may also use the [Fabric-starter-kit](../starter/fabric-starter-kit.md) that provides the network.

docs/index.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,13 @@ in this documentation, please use
7070

7171
Below, you'll find the following sections:
7272

73-
- [Getting started](#getting-started)
74-
- [Quickstart](#quickstart-documentation)
75-
- [Developer guides](#developer-guides)
76-
77-
- [Fabric developer's guide](#fabric-developer-guide)
78-
- [Chaincode developer's guide](#chaincode-developer-guide)
79-
- [API developer's guide](#api-developer-guide)
80-
81-
- [Operations guide](#operations-guide)
73+
* [Getting started](#getting-started)
74+
* [Quickstart](#quickstart-documentation)
75+
* [Developer guides](#developer-guides)
76+
* [Fabric developer's guide](#fabric-developer-guide)
77+
* [Chaincode developer's guide](#chaincode-developer-guide)
78+
* [API developer's guide](#api-developer-guide)
79+
* [Operations guide](#operations-guide)
8280

8381
# Getting started
8482

docs/nodeSDK/app-developer-env-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
make doc
3636
```
3737

38-
* To build the reference documentation in the [Self Contained Node.js Environment](node-sdk-self-contained.md):
38+
* To build the reference documentation in the [Fabric-starter-kit](../starter/fabric-starter-kit.md)
3939

4040
```
4141
docker exec -it nodesdk /bin/bash

docs/nodeSDK/node-sdk-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Hyperledger fabric Client (HFC) SDK for Node.js provides a powerful and easy
1010

1111
#### Development Environment Choices
1212

13-
* *Recommended:* [Self Contained Node.js Environment](node-sdk-self-contained.md) uses pre-built docker images for the Node.js client application interacting with Hyperledger fabric blockchain. This environment may suffice for a majority of Node.js application developers. The environment contains a built-in standalone sample ready to go.
13+
* *Recommended:* [Fabric-starter-kit](../starter/fabric-starter-kit.md) uses pre-built docker images for the Node.js client application interacting with Hyperledger fabric blockchain. This environment may suffice for a majority of Node.js application developers. The environment contains a built-in standalone sample ready to go.
1414

1515
* [Full Hyperledger fabric development environment](app-developer-env-setup.md) on how to set up an environment for developing chaincode and applications.
1616

@@ -29,4 +29,4 @@ The Hyperledger fabric Client (HFC) SDK for Node.js provides a powerful and easy
2929

3030
* To build the reference documentation for the Node.js client SDK APIs follow the instructions [here](app-developer-env-setup.md).
3131

32-
* To learn more about chaincode, see [Writing, Building, and Running Chaincode in a Development Environment](../Setup/Chaincode-setup.md).
32+
* To learn more about chaincode, see [Writing, Building, and Running Chaincode in a Development Environment](../Setup/Chaincode-setup.md).

mkdocs.yml

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: Hyperledger Fabric
22
site_url: http://hyperledger-fabric.readthedocs.io
33
theme: readthedocs
4-
repo_url: http://gerrit.hyperledger.org/r/fabric
4+
repo_url: https://github.com/hyperledger/fabric.git
55
site_description: 'Welcome to the Hyperledger fabric documentation'
66

77
pages:
@@ -13,7 +13,7 @@ pages:
1313
- Starter Kit:
1414
- Starter Kit: starter/fabric-starter-kit.md
1515

16-
- Installation and setup:
16+
- Installation and Setup:
1717
- Chaincode or Application Developer Setup: Setup/Chaincode-setup.md
1818
- Java Chaincode Setup: Setup/JAVAChaincode.md
1919
- Fabric Network Setup: Setup/Network-setup.md
@@ -22,7 +22,7 @@ pages:
2222
- TLS Setup: Setup/TLSSetup.md
2323
- Logging: Setup/logging-control.md
2424

25-
- APIs:
25+
- API's:
2626
- Chaincode APIs: API/ChaincodeAPI.md
2727
- Core API: API/CoreAPI.md
2828
- CA API: API/MemberServicesAPI.md
@@ -31,18 +31,18 @@ pages:
3131
- Fabric Developer:
3232
- v1.0 Preview: abstract_v1.md
3333
- Contributing: CONTRIBUTING.md
34-
- Getting an Account: Gerrit/lf-account.md
35-
- Gerrit: Gerrit/gerrit.md
34+
- Maintainers: MAINTAINERS.md
3635
- Fabric Developer Setup: dev-setup/devenv.md
3736
- Building Fabric: dev-setup/build.md
38-
- Best Practices: Gerrit/best-practices.md
39-
- Maintainers: MAINTAINERS.md
37+
- Getting an Account: Gerrit/lf-account.md
38+
- Gerrit: Gerrit/gerrit.md
4039
- Reviewing: Gerrit/reviewing.md
4140
- Changes: Gerrit/changes.md
42-
- Style guides:
41+
- Best Practices: Gerrit/best-practices.md
42+
- Go Style Guides:
4343
- Golang: Style-guides/go-style.md
4444

45-
- FAQ:
45+
- FAQ's:
4646
- ChainCodeFAQ: FAQ/chaincode_FAQ.md
4747
- ConfidentialityFAQ: FAQ/confidentiality_FAQ.md
4848
- ConsensusFAQ: FAQ/consensus_FAQ.md
@@ -63,6 +63,9 @@ pages:
6363
- Sample-web-app: nodeSDK/sample-web-app.md
6464

6565
markdown_extensions:
66+
- toc:
67+
permalink: true
68+
- admonition
6669
- extra
6770
- tables
6871
- toc

0 commit comments

Comments
 (0)