Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

Commit

Permalink
Doc fixes (#1365)
Browse files Browse the repository at this point in the history
* fix docs rstill referring to alpha 1

Signed-off-by: Dave Kelsey <[email protected]>

* further corrections

Signed-off-by: Dave Kelsey <[email protected]>
  • Loading branch information
Dave Kelsey authored Jun 22, 2017
1 parent 8ac2fbf commit c202c22
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In {{site.data.conrefs.hlf_full}} Beta peers now enforce the concepts of admins

When connecting to the peer you must specify an identity where the userID contains the text `admin`, for example, `PeerAdmin`, `myadmin`, or `AdminPeer` are all valid userID's. Peers in different organizations may have different admin users. Only an admin user of peer's organization will be able to deploy a business network to their peers.

These security changes mean that {{site.data.conrefs.composer_full}} cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).
Due to many breaking API changes between Hyperledger Fabric alpha 1 and Hyperledger Fabric beta, {{site.data.conrefs.composer_full}} only supports the beta level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).

### Deploying business networks using Playground locally

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ index-order: 3

Follow the instructions below to get the required {{site.data.conrefs.composer_full}} development tools and stand up a {{site.data.conrefs.hlf_full}}.

There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0-alpha. The default is for v1.0-alpha and we suggest this is the one you use.
There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0-beta. The default is for v1.0-beta and we suggest this is the one you use.

---

Expand Down Expand Up @@ -108,7 +108,7 @@ docker rmi $(docker images dev-* -q)

export FABRIC_VERSION=hlfv0.6

{{site.data.conrefs.hlf_full}} v1.0-alpha is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command
{{site.data.conrefs.hlf_full}} v1.0-beta is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command

export FABRIC_VERSION=hlfv1

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ index-order: 2

# Installing and running {{site.data.conrefs.composer_full}} Playground locally

This tutorial will take you through how to install and run the {{site.data.conrefs.composer_full}} Playground on your local machine. It also creates an instance of {{site.data.conrefs.hlf_full}} v1.0-Alpha1.
This tutorial will take you through how to install and run the {{site.data.conrefs.composer_full}} Playground on your local machine. It also creates an instance of {{site.data.conrefs.hlf_full}} v1.0-Beta.

{{site.data.conrefs.composer_full}} Playground can also be used in a "browser only" mode, without a running instance of {{site.data.conrefs.hlf_full}}. When used in this mode, all the functionality of {{site.data.conrefs.composer_full}} Playground is available, but all of the data (business networks, assets, participants, and transactions) is persisted into browser local storage.

Expand Down Expand Up @@ -48,7 +48,7 @@ In {{site.data.conrefs.hlf_full}} Beta peers now enforce the concepts of admins

When connecting to the peer you must specify an identity where the userID contains the text `admin`, for example, `PeerAdmin`, `myadmin`, or `AdminPeer` are all valid userID's. Peers in different organizations may have different admin users. Only an admin user of peer's organization will be able to deploy a business network to their peers.

These security changes mean that {{site.data.conrefs.composer_full}} cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).
Due to many breaking API changes between {{site.data.conrefs.hlf_full}} v1.0 alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 beta, {{site.data.conrefs.composer_full}} only supports the beta level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).

### Deploying business networks using Playground locally

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t
"maxRecvSize": 15
}

- `type` defines the version of {{site.data.conrefs.hlf_full}} that you will connect to. To connect to {{site.data.conrefs.hlf_full}} v1.0-alpha is must be `hlfv1`.
- `type` defines the version of {{site.data.conrefs.hlf_full}} that you will connect to. To connect to {{site.data.conrefs.hlf_full}} v1.0-beta is must be `hlfv1`.
- `orderers` is an array of objects which describe the orderes to communicate with. Within `orderers`, you must define the `url` of each orderer. If you are connecting via TLS, all `url` properties in your connection profile must begin with `grpcs://` and must also contain the correct TLS certificate in the `cert` property.
- `peers` is an array of objects describing the peers to communicate with. Each `peer` must have a defined `requestURL` and a defined `eventURL`. If you are connecting using TLS, each `peer` must also have the correct TLS certificate in the `cert` property.

Expand Down

0 comments on commit c202c22

Please sign in to comment.