Skip to content

Commit

Permalink
FAB-598: fixed nodesdk doc broken links
Browse files Browse the repository at this point in the history
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 <rameshbabu.thoomu@gmail.com>
  • Loading branch information
rameshthoomu committed Oct 17, 2016
1 parent e728c5c commit c8205c6
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 23 deletions.
3 changes: 1 addition & 2 deletions docs/Setup/NodeSDK-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,4 @@ See [Hyperledger fabric Node.js client SDK](../nodeSDK/node-sdk-guide.md) for mo
## Hyperledger fabric network

First, you'll want to have a running peer node and member services. The
instructions for setting up a network are
[here](Network-setup.md). You may also use the [self contained environment](../nodeSDK/node-sdk-self-contained.md) that provides the network.
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.
16 changes: 7 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,13 @@ in this documentation, please use

Below, you'll find the following sections:

- [Getting started](#getting-started)
- [Quickstart](#quickstart-documentation)
- [Developer guides](#developer-guides)

- [Fabric developer's guide](#fabric-developer-guide)
- [Chaincode developer's guide](#chaincode-developer-guide)
- [API developer's guide](#api-developer-guide)

- [Operations guide](#operations-guide)
* [Getting started](#getting-started)
* [Quickstart](#quickstart-documentation)
* [Developer guides](#developer-guides)
* [Fabric developer's guide](#fabric-developer-guide)
* [Chaincode developer's guide](#chaincode-developer-guide)
* [API developer's guide](#api-developer-guide)
* [Operations guide](#operations-guide)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion docs/nodeSDK/app-developer-env-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
make doc
```

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

```
docker exec -it nodesdk /bin/bash
Expand Down
4 changes: 2 additions & 2 deletions docs/nodeSDK/node-sdk-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Hyperledger fabric Client (HFC) SDK for Node.js provides a powerful and easy

#### Development Environment Choices

* *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.
* *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.

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

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

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

* To learn more about chaincode, see [Writing, Building, and Running Chaincode in a Development Environment](../Setup/Chaincode-setup.md).
* To learn more about chaincode, see [Writing, Building, and Running Chaincode in a Development Environment](../Setup/Chaincode-setup.md).
21 changes: 12 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: Hyperledger Fabric
site_url: http://hyperledger-fabric.readthedocs.io
theme: readthedocs
repo_url: http://gerrit.hyperledger.org/r/fabric
repo_url: https://github.com/hyperledger/fabric.git
site_description: 'Welcome to the Hyperledger fabric documentation'

pages:
Expand All @@ -13,7 +13,7 @@ pages:
- Starter Kit:
- Starter Kit: starter/fabric-starter-kit.md

- Installation and setup:
- Installation and Setup:
- Chaincode or Application Developer Setup: Setup/Chaincode-setup.md
- Java Chaincode Setup: Setup/JAVAChaincode.md
- Fabric Network Setup: Setup/Network-setup.md
Expand All @@ -22,7 +22,7 @@ pages:
- TLS Setup: Setup/TLSSetup.md
- Logging: Setup/logging-control.md

- APIs:
- API's:
- Chaincode APIs: API/ChaincodeAPI.md
- Core API: API/CoreAPI.md
- CA API: API/MemberServicesAPI.md
Expand All @@ -31,18 +31,18 @@ pages:
- Fabric Developer:
- v1.0 Preview: abstract_v1.md
- Contributing: CONTRIBUTING.md
- Getting an Account: Gerrit/lf-account.md
- Gerrit: Gerrit/gerrit.md
- Maintainers: MAINTAINERS.md
- Fabric Developer Setup: dev-setup/devenv.md
- Building Fabric: dev-setup/build.md
- Best Practices: Gerrit/best-practices.md
- Maintainers: MAINTAINERS.md
- Getting an Account: Gerrit/lf-account.md
- Gerrit: Gerrit/gerrit.md
- Reviewing: Gerrit/reviewing.md
- Changes: Gerrit/changes.md
- Style guides:
- Best Practices: Gerrit/best-practices.md
- Go Style Guides:
- Golang: Style-guides/go-style.md

- FAQ:
- FAQ's:
- ChainCodeFAQ: FAQ/chaincode_FAQ.md
- ConfidentialityFAQ: FAQ/confidentiality_FAQ.md
- ConsensusFAQ: FAQ/consensus_FAQ.md
Expand All @@ -63,6 +63,9 @@ pages:
- Sample-web-app: nodeSDK/sample-web-app.md

markdown_extensions:
- toc:
permalink: true
- admonition
- extra
- tables
- toc
Expand Down

0 comments on commit c8205c6

Please sign in to comment.