Skip to content

Commit

Permalink
document fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rameshthoomu committed Jul 15, 2016
1 parent f7d9321 commit bfa09cd
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 11 deletions.
8 changes: 4 additions & 4 deletions docs/Setup/Chaincode-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Chaincode developers need a way to test and debug their chaincode without having to set up a complete peer network. By default, when you want to interact with chaincode, you need to first `Deploy` it using the CLI, REST API, gRPC API, or SDK. Upon receiving this request, the peer node would typically spin up a Docker container with the relevant chaincode. This can make things rather complicated for debugging chaincode under development, because of the turnaround time with the `launch chaincode - debug docker container - fix problem - launch chaincode - lather - rinse - repeat` cycle. As such, the fabric peer has a `--peer-chaincodedev` flag that can be passed on start-up to instruct the peer node not to deploy the chaincode as a Docker container.

The following instructions apply to _developing_ chaincode in Go or Java. They do not apply to running in a production environment. However, if _developing_ chaincode in Java, please see the [Java chaincode setup](JAVAchaincode.md) instructions first, to be sure your environment is properly configured.
The following instructions apply to _developing_ chaincode in Go or Java. They do not apply to running in a production environment. However, if _developing_ chaincode in Java, please see the [Java chaincode setup](https://github.com/hyperledger/fabric/blob/master/docs/Setup/JAVAChaincode.md) instructions first, to be sure your environment is properly configured.

**Note:** We have added support for [System chaincode](../SystemChaincode/noop.md).
**Note:** We have added support for [System chaincode](https://github.com/hyperledger/fabric/blob/master/docs/SystemChaincodes/noop.md).

## Choices

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

- [Option 1](#Option-1-Vagrant-development-environment) using the **Vagrant** [development environment](../dev-setup/devenv.md) that is used for developing the fabric itself
- [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
- [Option 2](#Option-2-Docker-for-Mac-or-Windows) using Docker for Mac or Windows
- [Option 3](#Option-3-Docker-Toolbox) using Docker toolbox

Expand Down Expand Up @@ -211,7 +211,7 @@ The chaincode console will display the message "Received REGISTERED, ready for i

If you were running with security enabled, see [Removing temporary files when security is enabled](#removing-temporary-files-when-security-is-enabled) to learn how to clean up the temporary files.

See the [logging control](../Setup/logging-control.md) reference for information on controlling
See the [logging control](https://github.com/hyperledger/fabric/blob/master/docs/Setup/logging-control.md) reference for information on controlling
logging output from the `peer` and chaincodes.

### Terminal 3 (CLI or REST API)
Expand Down
2 changes: 1 addition & 1 deletion docs/Setup/NodeSDK-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ function handleUserRequest(userName, chaincodeID, fcn, args) {

## Getting Set Up

First, you'll want to have a running peer node and CA. You can follow the instructions for setting up a network [here](../../docs/Setup/ca-setup.md#Operating-the-CA), and start a single peer node and CA.
First, you'll want to have a running peer node and CA. You can follow the instructions for setting up a network [here](https://github.com/hyperledger/fabric/blob/master/docs/Setup/ca-setup.md#Operating-the-CA), and start a single peer node and CA.

### Chaincode Deployment Directory Structure

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-setup/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,4 +187,4 @@ Logging utilizes the [go-logging](https://github.com/op/go-logging) library.

The available log levels in order of increasing verbosity are: *CRITICAL | ERROR | WARNING | NOTICE | INFO | DEBUG*

See [specific logging control](logging-control.md) instructions when running the peer process.
See [specific logging control](https://github.com/hyperledger/fabric/blob/master/docs/Setup/logging-control.md) instructions when running the peer process.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ When you are ready to start contributing to the Hyperledger fabric project, we s
- [APIs - CLI, REST, and Node.js](API/CoreAPI.md)
- [CLI](API/CoreAPI.md#cli): working with the command-line interface.
- [REST](API/CoreAPI.md#rest-api): working with the REST API.
- [Node.js SDK](../sdk/node/README.md): working with the Node.js SDK.
- [Node.js SDK](https://github.com/hyperledger/fabric/blob/master/sdk/node/README.md): working with the Node.js SDK.

## Operations guide

Expand Down
11 changes: 7 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,20 @@ pages:
- Usecases: biz/usecases.md

- Setup:
- Fabric Developer Setup: dev-setup/devenv.md
- Chaincode or Application Developer Setup: Setup/Chaincode-setup.md
- Java Chaincode Setup: Setup/JAVAchaincode.md
- Development Environment: dev-setup/devenv.md
- Building Fabric: dev-setup/build.md
- Chaincode Setup: Setup/Chaincode-setup.md
- Java Chaincode Setup: Setup/JAVAChaincode.md
- Fabric Network Setup: Setup/Network-setup.md
- NodeSDK Setup: Setup/NodeSDK-setup.md
- CA Setup: Setup/ca-setup.md
- Logging: Setup/logging-control.md

- API:
- Chaincode APIs: API/ChaincodeAPI.md
- Core API: API/CoreAPI.md
- CA API: API/MemberServicesAPI.md
- System chaincode: Systemchaincode/noop.md
- System Chaincode: SystemChaincodes/noop.md

- FAQ:
- ChainCodeFAQ: FAQ/chaincode_FAQ.md
Expand Down

0 comments on commit bfa09cd

Please sign in to comment.