Skip to content

Commit

Permalink
[FAB-10958]Fix typos and broken links
Browse files Browse the repository at this point in the history
This CR fixes some typos and broken links in documents.

Change-Id: Id3aa3743cbd3f7a5f92ccd0b458b81d26dc8bc70
Signed-off-by: Yuki Kondo <[email protected]>
  • Loading branch information
yuki-kon committed Jun 29, 2018
1 parent b0b4c49 commit 65675e4
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/tutorials/channel-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following assumes an understanding of the Hyperledger Fabric network
and of Node application development, including the use of the
Javascript `Promise`.

The examples shown below are based on the `balance-transfer` sample application. see [Hyperledger Fabric Samples](http://hyperledger-fabric.readthedocs.io/en/latest/samples.html)
The examples shown below are based on the `balance-transfer` sample application. see [Hyperledger Fabric Samples](https://github.com/hyperledger/fabric-samples/tree/master/balance-transfer)

### steps of a channel create:
* run the configtxgen tool to generate a genesis block
Expand All @@ -52,7 +52,7 @@ The examples shown below are based on the `balance-transfer` sample application.
## Use the initial definition to build a sign-able channel definition

The initial binary channel configuration definition generated by the
[configtxgen tool](http://hyperledger-fabric.readthedocs.io/en/latest/configtxgen.html)
[configtxgen tool](http://hyperledger-fabric.readthedocs.io/en/latest/configtx.html)
is a binary file containing the Hyperledger Fabric configuration protobuf
`common.Envelope` element. Inside this element is the `common.ConfigUpdate`
protobuf element. This configuration element is the one that must be signed.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/channel-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ let event_monitor = new Promise((resolve, reject) => {
// might be good to store the block number to be able to resume if offline
storeBlockNumForLater(block_num);
// to see the event payload, the channel_event_hub must be conneted(true)
// to see the event payload, the channel_event_hub must be connected(true)
let event_payload = event.payload.toString('utf8');
if(event_payload.indexOf('CHAINCODE') > -1) {
clearTimeout(handle);
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ a time until it receives a successful submission of the transaction. Sending
a transaction (a set of endorsements) to an orderer does not mean that the transaction
will be committed, it means that the request was built properly and that the
sender has the authority to send the request. The response from the orderer
will indicate that the orderer has excepted the request. The `sendTransaction`
will indicate that the orderer has accepted the request. The `sendTransaction`
has an optional parameter `orderer` that indicates the orderer to send the
transaction. The handler will use the orderer as specified with the `orderer`
parameter and send to any other orderers. If no orderer is specified the handler
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This tutorial illustrates how to use the Hyperledger Fabric Node.js client loggi
### Overview

Hyperledger Fabric Node.js client logging uses the Node.js 'winston' package.
The logging is initialized when the Node.js applicatiion first loads the Hyperledger
The logging is initialized when the Node.js application first loads the Hyperledger
Fabric package. All Hyperledger Fabric client objects will use the same settings (Peer, Orderer, ChannelEventHub).
```
const Client = require('fabric-client');
Expand Down Expand Up @@ -52,7 +52,7 @@ const logger = Client.getLogger('APPLICATION');

prior to 1.2
```
const sdkUtils = = require('fabric-client/lib/utils.js');
const sdkUtils = require('fabric-client/lib/utils.js');
const logger = sdkUtils.getLogger('APPLICATION');
```

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/network-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ A connection profile contain entries that describe the Hyperledger Fabric networ
* `Client.loadFromConfig()` - A static utility method to get a fabric client instance loaded with the connection profile configuration.
* `client.loadFromConfig()` - A fabric client instance method to load a connection profile configuration, overriding any existing connection profile configuration settings that may have been set when this client object was created by the call above.

#### new API's that use a loaded connetion profile
#### new API's that use a loaded connection profile
* `client.initCredentialStores()` - A fabric client instance method to create a state store and assign it to the fabric client instance based on the current settings in the loaded connection profile configuration. It will also create the crypto suite and assign it to the fabric client instance. A crypto store will be created and assigned to crypto suite if needed. (HSM based crypto suites do not require a crypto store).
* `client.setTlsClientCertAndKey(clientCert, clientKey)` -A fabric client instance method that will set a certificate and the corresponding private key on the client instance. Mutual TLS client settings are not stored within the connection profile. When a peer or orderer instance is created for the user from the endpoints defined in the connection profile, these settings will be used as the client mutual TLS settings. When using mutual TLS and a connection profile, this method must be called before endpoints are required. Calling this method is only required when using mutual TLS and a connection profile.
* `channel.newChannelEventHub()` - A fabric channel instance method to create an channel-based event hub based on the current settings in the loaded connection profile configuration of the named peer.
Expand Down Expand Up @@ -146,7 +146,7 @@ certificateAuthorities:
caName: caorg2
```

The following example will have an existing fabric client load a connection profile configuration. The definition will only contain client side definitions and no fabric network definitions. Calling for a load on an existing fabric client does an overlay of the top level sections in the file being loaded replacing the sections on those previously loaded. In this case the file being loaded only has a client section, therefore the loaded definition will now have the perviously loaded channels, organizations, peers, orderers, and certificateAuthorities section definitions and the newly loaded client section definition. This allows for an existing fabric client to be able to work within different organization.
The following example will have an existing fabric client load a connection profile configuration. The definition will only contain client side definitions and no fabric network definitions. Calling for a load on an existing fabric client does an overlay of the top level sections in the file being loaded replacing the sections on those previously loaded. In this case the file being loaded only has a client section, therefore the loaded definition will now have the previously loaded channels, organizations, peers, orderers, and certificateAuthorities section definitions and the newly loaded client section definition. This allows for an existing fabric client to be able to work within different organization.
```
client.loadFromConfig('test/fixtures/org1.yaml');
```
Expand Down Expand Up @@ -306,7 +306,7 @@ When there is a connection profile configuration loaded and the query call is no
### When monitoring for events
Working with an channel-based event hub will not changed when a connection profile configuration has been loaded. A new method has been added to the fabric client to simplify setting up of an ChannelEventHub object. Use the following to get an ChannelEventHub object that will be setup to work with the named peer's channel-based event hub.
```
var chanel_event_hub = channel.newChannelEventHub('peer0.org1.example.com');
var channel_event_hub = channel.newChannelEventHub('peer0.org1.example.com');
```
Notice how the parameter to the call is the name of the peer. All settings to create an channel-based event hub are defined by the connection profile configuration under the peer by that name.
```
Expand Down
2 changes: 1 addition & 1 deletion fabric-ca-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![NPM](https://nodei.co/npm/fabric-ca-client.svg?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/fabric-fabric-ca-client/)

SDK for writing node.js applications to interact with [Hyperledger Fabric CA](http://hyperledger-fabric.readthedocs.io/en/latest/Setup/ca-setup.html).
SDK for writing node.js applications to interact with [Hyperledger Fabric CA](http://hyperledger-fabric-ca.readthedocs.io/en/latest/users-guide.html).

This package encapsulates the APIs to interact with the Fabric CA to manage user certificates lifecycle such as register, enroll, renew and revoke.

Expand Down
4 changes: 2 additions & 2 deletions fabric-client/lib/Peer.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ var Peer = class extends Remote {
* or runs queries.
*
* @param {Proposal} proposal - A protobuf encoded byte array of type
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/v1.2.0/protos/peer/proposal.proto}
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/release-1.2/protos/peer/proposal.proto}
* @param {Number} timeout - A number indicating milliseconds to wait on the
* response before rejecting the promise with a timeout error. This
* overrides the default timeout of the Peer instance and the global
Expand Down Expand Up @@ -122,7 +122,7 @@ var Peer = class extends Remote {
* Send an discovery request to this peer.
*
* @param {SignedRequest} request - A protobuf encoded byte array of type
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/v1.2.0/protos/discovery/protocol.proto}
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/release-1.2/protos/discovery/protocol.proto}
* @param {Number} timeout - A number indicating milliseconds to wait on the
* response before rejecting the promise with a timeout error. This
* overrides the default timeout of the Peer instance and the global
Expand Down

0 comments on commit 65675e4

Please sign in to comment.