From c0f9e9f0ec88ff4d268e527a90aed6986a87d418 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Wed, 5 Jul 2017 17:12:47 +0100 Subject: [PATCH 1/7] Woooh changes.... --- .../applications/applications-index.md | 2 +- .../jekylldocs/applications/node.md | 2 +- .../applications/subscribing-to-events.md | 2 +- .../jekylldocs/applications/web.md | 2 +- .../jekylldocs/business-network/bnd-create.md | 4 ++- .../jekylldocs/business-network/bnd-deploy.md | 4 ++- .../business-network/bnd-publish.md | 4 ++- .../business-network-index.md | 4 ++- .../businessnetworkdefinition.md | 4 ++- .../business-network/publishing-events.md | 4 ++- .../jekylldocs/business-network/query.md | 3 +- .../jekylldocs/business-network/testing.md | 4 ++- .../installing/development-tools.md | 2 +- .../getting-started-with-playground.md | 2 +- .../jekylldocs/installing/installing-index.md | 2 +- .../installing/using-playground-locally.md | 2 +- .../jekylldocs/integrating/call-out.md | 2 +- .../integrating/deploying-the-rest-server.md | 2 +- .../enabling-rest-authentication.md | 2 +- .../integrating/getting-started-rest-api.md | 2 +- .../integrating/integrating-index.md | 2 +- .../jekylldocs/integrating/node-red.md | 2 +- .../introduction/businessnetworkdefinition.md | 2 +- .../jekylldocs/introduction/introduction.md | 6 ++-- .../jekylldocs/introduction/key-concepts.md | 9 ++--- .../introduction/solution-architecture.md | 7 ++-- .../managing/current-participant.md | 2 +- .../jekylldocs/managing/github-oauth.md | 2 +- .../jekylldocs/managing/identity-issue.md | 2 +- .../jekylldocs/managing/identity-revoke.md | 2 +- .../jekylldocs/managing/managingindex.md | 2 +- .../jekylldocs/managing/participant-add.md | 2 +- .../managing/participantsandidentities.md | 2 +- .../jekylldocs/managing/updating-composer.md | 27 +++++++++++++-- .../jekylldocs/problems/diagnostics.md | 4 ++- .../jekylldocs/reference/JSDOC-README.md | 34 +++++++++++++++++++ .../reference/composer.network.logLevel.md | 27 +++++++++++++++ .../jekylldocs/support/index.md | 4 ++- .../jekylldocs/tutorials/developer-guide.md | 2 +- .../jekylldocs/tutorials/playground-guide.md | 2 +- .../jekylldocs/tutorials/tutorials.md | 2 +- 41 files changed, 152 insertions(+), 47 deletions(-) create mode 100644 packages/composer-website/jekylldocs/reference/JSDOC-README.md create mode 100644 packages/composer-website/jekylldocs/reference/composer.network.logLevel.md diff --git a/packages/composer-website/jekylldocs/applications/applications-index.md b/packages/composer-website/jekylldocs/applications/applications-index.md index ecb4477b24..06a3bb9522 100644 --- a/packages/composer-website/jekylldocs/applications/applications-index.md +++ b/packages/composer-website/jekylldocs/applications/applications-index.md @@ -4,7 +4,7 @@ title: Developing Applications section: applications category: start index-order: 0 -sidebar: sidebars/applications.md +sidebar: sidebars/accordion-toc.md excerpt: Writing a node.js application --- diff --git a/packages/composer-website/jekylldocs/applications/node.md b/packages/composer-website/jekylldocs/applications/node.md index 47826d3a4c..dc6ab503a6 100644 --- a/packages/composer-website/jekylldocs/applications/node.md +++ b/packages/composer-website/jekylldocs/applications/node.md @@ -4,7 +4,7 @@ title: Writing a Node.js application section: applications category: start index-order: 1 -sidebar: sidebars/applications.md +sidebar: sidebars/accordion-toc.md excerpt: "[**Developing Node.js applications to work with Hyperledger Composer**](./node.html) allows you to programmatically connect to a deployed business network, create, read, update and delete assets and participants and to submit transactions." --- diff --git a/packages/composer-website/jekylldocs/applications/subscribing-to-events.md b/packages/composer-website/jekylldocs/applications/subscribing-to-events.md index 4b5f131afb..3bc5fc701a 100644 --- a/packages/composer-website/jekylldocs/applications/subscribing-to-events.md +++ b/packages/composer-website/jekylldocs/applications/subscribing-to-events.md @@ -4,7 +4,7 @@ title: Subscribing to events category: tasks section: applications index-order: 3 -sidebar: sidebars/applications.md +sidebar: sidebars/accordion-toc.md excerpt: Node.js applications can [**subscribe to events from a business network**](./subscribing-to-events.html) by using the `composer-client.BusinessNetworkConnection.on` API call. Events are defined in the business network model file and are emitted by specified transactions in the transaction processor function file. --- diff --git a/packages/composer-website/jekylldocs/applications/web.md b/packages/composer-website/jekylldocs/applications/web.md index da74fabc82..febc5a3e25 100644 --- a/packages/composer-website/jekylldocs/applications/web.md +++ b/packages/composer-website/jekylldocs/applications/web.md @@ -4,7 +4,7 @@ title: Writing Web or mobile applications category: start section: applications index-order: 2 -sidebar: sidebars/applications.md +sidebar: sidebars/accordion-toc.md excerpt: Web or mobile applications that need to interact with deployed business networks should make calls to a REST API. The easiest way to create the REST API is to use the `composer-rest-server` to [**dynamically generate a REST API from the deployed business network**](./web.html). --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-create.md b/packages/composer-website/jekylldocs/business-network/bnd-create.md index 67143680a1..e95ba8a5a5 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-create.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-create.md @@ -2,7 +2,9 @@ layout: default title: Task - Create a Business Network Definition category: tasks -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 2 +sidebar: sidebars/accordion-toc.md excerpt: How to create a business network definition --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md index d6c4dcb515..ce8923197e 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md @@ -2,7 +2,9 @@ layout: default title: Task - Deploying and Updating Business Networks category: tasks -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 3 +sidebar: sidebars/accordion-toc.md excerpt: How to deploy or update Business Networks --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-publish.md b/packages/composer-website/jekylldocs/business-network/bnd-publish.md index 9a04d33df8..031ffdef41 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-publish.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-publish.md @@ -2,7 +2,9 @@ layout: default title: Task - Publish Models or Business Network Definitions category: tasks -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 6 +sidebar: sidebars/accordion-toc.md excerpt: How to publish a model or business network definition for use by applications --- diff --git a/packages/composer-website/jekylldocs/business-network/business-network-index.md b/packages/composer-website/jekylldocs/business-network/business-network-index.md index 29c1ed2678..ec850e2de9 100644 --- a/packages/composer-website/jekylldocs/business-network/business-network-index.md +++ b/packages/composer-website/jekylldocs/business-network/business-network-index.md @@ -2,7 +2,9 @@ layout: default title: Hyperledger Composer - Developing Business Networks category: concepts -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 0 +sidebar: sidebars/accordion-toc.md excerpt: Overview of Developing Business Networks --- diff --git a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md index 0575117e3e..4b9979b646 100644 --- a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md @@ -2,7 +2,9 @@ layout: default title: Hyperledger Composer - Business Network Definition category: concepts -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 1 +sidebar: sidebars/accordion-toc.md excerpt: Overview of the Business Network Definition --- diff --git a/packages/composer-website/jekylldocs/business-network/publishing-events.md b/packages/composer-website/jekylldocs/business-network/publishing-events.md index 30c4482d49..6539ca2e90 100644 --- a/packages/composer-website/jekylldocs/business-network/publishing-events.md +++ b/packages/composer-website/jekylldocs/business-network/publishing-events.md @@ -2,7 +2,9 @@ layout: default title: Emitting Events category: tasks -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 4 +sidebar: sidebars/accordion-toc.md excerpt: Emitting Events from Transaction Processor Functions --- diff --git a/packages/composer-website/jekylldocs/business-network/query.md b/packages/composer-website/jekylldocs/business-network/query.md index 16e1b1854c..36beb09929 100644 --- a/packages/composer-website/jekylldocs/business-network/query.md +++ b/packages/composer-website/jekylldocs/business-network/query.md @@ -3,7 +3,8 @@ layout: default title: Querying Business Network Data category: tasks section: business-network -sidebar: sidebars/businessnetworks.md +index-order: 7 +sidebar: sidebars/accordion-toc.md excerpt: Queries are used to return data about the blockchain world-state; for example, you could write a query to return all drivers over a defined age parameter, or all drivers with a specific name. --- diff --git a/packages/composer-website/jekylldocs/business-network/testing.md b/packages/composer-website/jekylldocs/business-network/testing.md index 12a4257090..efb4122b41 100644 --- a/packages/composer-website/jekylldocs/business-network/testing.md +++ b/packages/composer-website/jekylldocs/business-network/testing.md @@ -2,7 +2,9 @@ layout: default title: Task - Testing Business Networks category: tasks -sidebar: sidebars/businessnetworks.md +section: business-network +index-order: 5 +sidebar: sidebars/accordion-toc.md excerpt: How to test business networks --- diff --git a/packages/composer-website/jekylldocs/installing/development-tools.md b/packages/composer-website/jekylldocs/installing/development-tools.md index ba2753afba..1b4df1df27 100644 --- a/packages/composer-website/jekylldocs/installing/development-tools.md +++ b/packages/composer-website/jekylldocs/installing/development-tools.md @@ -3,7 +3,7 @@ layout: default title: Installing a development environment category: start section: installing -sidebar: sidebars/installing.md +sidebar: sidebars/accordion-toc.md excerpt: To install the command line and development tools, along with a local instance of Hyperledger Fabric click [**Install Development Tools**](../installing/development-tools.html) here or in the table of contents on the left. index-order: 3 --- diff --git a/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md b/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md index 2663f7d119..8f45268dd3 100644 --- a/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md +++ b/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md @@ -2,7 +2,7 @@ layout: default title: Using the Playground online category: tasks -sidebar: sidebars/installing.md +sidebar: sidebars/accordion-toc.md section: installing excerpt: To jump into the online Playground, click [**Try Online Playground**](../installing/getting-started-with-playground.html) here or in the table of contents on the left. index-order: 1 diff --git a/packages/composer-website/jekylldocs/installing/installing-index.md b/packages/composer-website/jekylldocs/installing/installing-index.md index bf21c2a0e7..7460f8ba2c 100644 --- a/packages/composer-website/jekylldocs/installing/installing-index.md +++ b/packages/composer-website/jekylldocs/installing/installing-index.md @@ -2,7 +2,7 @@ layout: default title: Installing Index category: tasks -sidebar: sidebars/installing.md +sidebar: sidebars/accordion-toc.md section: installing index-order: 0 excerpt: Tutorials diff --git a/packages/composer-website/jekylldocs/installing/using-playground-locally.md b/packages/composer-website/jekylldocs/installing/using-playground-locally.md index cad98245a6..d7018c4207 100644 --- a/packages/composer-website/jekylldocs/installing/using-playground-locally.md +++ b/packages/composer-website/jekylldocs/installing/using-playground-locally.md @@ -2,7 +2,7 @@ layout: default title: Installing the Playground locally category: start -sidebar: sidebars/installing.md +sidebar: sidebars/accordion-toc.md section: installing excerpt: To run the Playground locally with a local instance of Hyperledger Fabric, click [**Install Local Playground**](../installing/using-playground-locally.html) here or in the table of contents on the left. index-order: 2 diff --git a/packages/composer-website/jekylldocs/integrating/call-out.md b/packages/composer-website/jekylldocs/integrating/call-out.md index 1986c789d5..c55f1b5d3c 100644 --- a/packages/composer-website/jekylldocs/integrating/call-out.md +++ b/packages/composer-website/jekylldocs/integrating/call-out.md @@ -5,7 +5,7 @@ category: start section: integrating status: experimental index-order: 4 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: "[**Transaction processor functions can be used to call external REST services**](./call-out.html). This allows you to move complex computation off the blockchain." --- diff --git a/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md b/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md index 63c4908a8b..d89a0863c3 100644 --- a/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md +++ b/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md @@ -4,7 +4,7 @@ title: Deploying the REST server for a business network category: start section: integrating index-order: 3 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: By deploying a REST server for a business network, you can [**integrate existing systems and data with your Hyperledger Composer business network**](./deploying-the-rest-server.html), allowing you to create, update, or delete assets and participants, as well as get and submit transactions. --- diff --git a/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md b/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md index ff9104c8df..9da0b6c80b 100644 --- a/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md +++ b/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md @@ -4,7 +4,7 @@ title: Enabling REST API authentication for a business network category: start section: integrating index-order: 2 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: By default, the Hyperledger Composer REST server services all requests by using the Blockchain identity specified on the command line at startup. By [**enabling authentication, the identity of the client can be used to digitally sign all transactions made by that client.**](./enabling-rest-authentication.html) --- diff --git a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md index 1710ad9e8b..f6ef7be59c 100644 --- a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md +++ b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md @@ -4,7 +4,7 @@ title: Generating a REST API category: start section: integrating index-order: 1 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: Hyperledger Composer includes a standalone [**Node.js process that exposes a business network as a REST API**](./getting-started-rest-api.html). The LoopBack framework is used to generate an Open API, described by a Swagger document. --- diff --git a/packages/composer-website/jekylldocs/integrating/integrating-index.md b/packages/composer-website/jekylldocs/integrating/integrating-index.md index 949b13b11f..13ba7a5ff9 100644 --- a/packages/composer-website/jekylldocs/integrating/integrating-index.md +++ b/packages/composer-website/jekylldocs/integrating/integrating-index.md @@ -4,7 +4,7 @@ title: Integrating Index category: concepts section: integrating index-order: 0 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: How to create a new Connection Profile --- diff --git a/packages/composer-website/jekylldocs/integrating/node-red.md b/packages/composer-website/jekylldocs/integrating/node-red.md index 968a435d2f..0af33bbcb1 100644 --- a/packages/composer-website/jekylldocs/integrating/node-red.md +++ b/packages/composer-website/jekylldocs/integrating/node-red.md @@ -4,7 +4,7 @@ title: Integrating with Node-RED category: integrating section: integrating index-order: 5 -sidebar: sidebars/integrating.md +sidebar: sidebars/accordion-toc.md excerpt: "[Node-RED](http://nodered.org) includes a number of [**Hyperledger Composer _nodes_ allowing you to submit transactions, read, update and delete assets and participants, and subscribe to events.**](./node-red.html)" --- diff --git a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md index 78aba226b6..9529d795f0 100644 --- a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md @@ -2,7 +2,7 @@ layout: default title: Hyperledger Composer - Business Network Definition category: concepts -sidebar: sidebars/introduction.md +sidebar: sidebars/accordion-toc.md excerpt: Overview of the Business Network Definition --- diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index 19a952eaa0..081ae63ff2 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -1,8 +1,10 @@ --- layout: default -title: Hyperledger Composer - Overview +title: Introduction category: overview -sidebar: sidebars/introduction.md +section: introduction +index-order: 0 +sidebar: sidebars/accordion-toc.md excerpt: Hyperledger Composer overview --- diff --git a/packages/composer-website/jekylldocs/introduction/key-concepts.md b/packages/composer-website/jekylldocs/introduction/key-concepts.md index 1399141825..295e636d41 100644 --- a/packages/composer-website/jekylldocs/introduction/key-concepts.md +++ b/packages/composer-website/jekylldocs/introduction/key-concepts.md @@ -1,11 +1,12 @@ --- layout: default -title: Key Concepts in Hyperledger Composer -sidebar: sidebars/introduction.md -excerpt: +title: Key Concepts +sidebar: sidebars/accordion-toc.md +section: introduction +index-order: 1 --- -# Features and Concepts in {{site.data.conrefs.composer_full}} +# Key Concepts in {{site.data.conrefs.composer_full}} {{site.data.conrefs.composer_full}} is a programming model containing a modeling language, and a set of APIs to quickly define and deploy business networks and applications that allow **participants** to send **transactions** that exchange **assets**. diff --git a/packages/composer-website/jekylldocs/introduction/solution-architecture.md b/packages/composer-website/jekylldocs/introduction/solution-architecture.md index 5d155c023e..174ac4aeb9 100644 --- a/packages/composer-website/jekylldocs/introduction/solution-architecture.md +++ b/packages/composer-website/jekylldocs/introduction/solution-architecture.md @@ -1,8 +1,9 @@ --- layout: default -title: Solution Architecture -sidebar: sidebars/introduction.md -excerpt: +title: Typical Solution Architecture +sidebar: sidebars/accordion-toc.md +section: introduction +index-order: 2.5 --- # Typical {{site.data.conrefs.composer_full}} Solution Architecture diff --git a/packages/composer-website/jekylldocs/managing/current-participant.md b/packages/composer-website/jekylldocs/managing/current-participant.md index dee4c9220d..a023dcce3e 100644 --- a/packages/composer-website/jekylldocs/managing/current-participant.md +++ b/packages/composer-website/jekylldocs/managing/current-participant.md @@ -3,7 +3,7 @@ layout: default title: Implementing participant-based access control category: tasks section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: Transaction processor functions can be used to [**implement participant-based access control**](../managing/current-participant.html) by checking the participant type and identifier. index-order: 6 --- diff --git a/packages/composer-website/jekylldocs/managing/github-oauth.md b/packages/composer-website/jekylldocs/managing/github-oauth.md index c45135aa2c..3fbd4c646f 100644 --- a/packages/composer-website/jekylldocs/managing/github-oauth.md +++ b/packages/composer-website/jekylldocs/managing/github-oauth.md @@ -3,7 +3,7 @@ layout: default title: Enabling Playground OAuth with GitHub category: tasks section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: By [**enabling OAuth with GitHub**](../managing/github-oauth.html), you avoid an error if the GitHub rate limit is hit. index-order: 5 --- diff --git a/packages/composer-website/jekylldocs/managing/identity-issue.md b/packages/composer-website/jekylldocs/managing/identity-issue.md index 6952302c88..b17179a33e 100644 --- a/packages/composer-website/jekylldocs/managing/identity-issue.md +++ b/packages/composer-website/jekylldocs/managing/identity-issue.md @@ -3,7 +3,7 @@ layout: default title: Issuing an identity to a participant category: tasks section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: "[**An identity can be issued to a participant using either the API or the command line**](../managing/identity-issue.html). Once an identity has been issued, the identity can then be used by the participant to interact with the business network in the context of that participant." index-order: 3 --- diff --git a/packages/composer-website/jekylldocs/managing/identity-revoke.md b/packages/composer-website/jekylldocs/managing/identity-revoke.md index 6b93d6dcf2..a389df8f76 100644 --- a/packages/composer-website/jekylldocs/managing/identity-revoke.md +++ b/packages/composer-website/jekylldocs/managing/identity-revoke.md @@ -3,7 +3,7 @@ layout: default title: Revoking the identity of a participant category: tasks section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: "[**An identity can be revoked from a participant using either the API or the command line**](../managing/identity-revoke.html). Once an identity has been revoked, the identity can no longer be used by the participant to interact with the business network in the context of that participant." index-order: 4 --- diff --git a/packages/composer-website/jekylldocs/managing/managingindex.md b/packages/composer-website/jekylldocs/managing/managingindex.md index 17e3bef64b..45044635a4 100644 --- a/packages/composer-website/jekylldocs/managing/managingindex.md +++ b/packages/composer-website/jekylldocs/managing/managingindex.md @@ -4,7 +4,7 @@ title: Managing Index category: concepts section: managing index-order: 0 -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: "Managing your {{site.data.conrefs.composer_full}}" --- diff --git a/packages/composer-website/jekylldocs/managing/participant-add.md b/packages/composer-website/jekylldocs/managing/participant-add.md index 994fdc133a..8149503a3d 100644 --- a/packages/composer-website/jekylldocs/managing/participant-add.md +++ b/packages/composer-website/jekylldocs/managing/participant-add.md @@ -3,7 +3,7 @@ layout: default title: Adding participants category: tasks section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: "[**Participants must be added to a business network**](../managing/participant-add.html) before they can make transactions. Participants can create assets, and also exchange assets with other participants. A participant works with assets by submitting transactions." index-order: 2 --- diff --git a/packages/composer-website/jekylldocs/managing/participantsandidentities.md b/packages/composer-website/jekylldocs/managing/participantsandidentities.md index 16c607929d..7821f31dc7 100644 --- a/packages/composer-website/jekylldocs/managing/participantsandidentities.md +++ b/packages/composer-website/jekylldocs/managing/participantsandidentities.md @@ -3,7 +3,7 @@ layout: default title: Participants and identities category: concepts section: managing -sidebar: sidebars/managing.md +sidebar: sidebars/accordion-toc.md excerpt: Participants and identities are core concepts of Hyperledger Composer. A participant is a member of business networks and might represent individuals or organizations. Participants have identity documents which can be validated to prove their identity. For more information, see [**participants and identities**](../managing/participantsandidentities.html). index-order: 1 --- diff --git a/packages/composer-website/jekylldocs/managing/updating-composer.md b/packages/composer-website/jekylldocs/managing/updating-composer.md index baf08b8440..6c0c9fdf90 100644 --- a/packages/composer-website/jekylldocs/managing/updating-composer.md +++ b/packages/composer-website/jekylldocs/managing/updating-composer.md @@ -3,11 +3,32 @@ layout: default title: Updating Hyperledger Composer category: tasks section: managing -sidebar: sidebars/managing.md -excerpt: +sidebar: sidebars/accordion-toc.md +excerpt: To [update Hyperledger Composer](./updating-composer.html) to a new version, the Hyperledger Composer components must be uninstalled and reinstalled using npm. index-order: 7 --- # Updating {{site.data.conrefs.composer_full}} -After deploying {{site.data.conrefs.composer_full}} you may wish to upgrade to a new version for additional functionality. +After deploying {{site.data.conrefs.composer_full}} you may wish to upgrade to a new version. To update your installed version of {{site.data.conrefs.composer_full}} you must uninstall the client, admin, and runtime CLI components and reinstall them by using npm. + +## Procedure + +1. Uninstall the {{site.data.conrefs.composer_full}} components by using the following commands: + + npm uninstall -g composer-cli + npm uninstall -g composer-rest-server + npm uninstall -g generator-fabric-composer + +2. Install the latest version of the {{site.data.conrefs.composer_full}} components by using the following commands: + + npm install -g composer-cli + npm install -g composer-rest-server + npm install -g generator-fabric-composer + + +## What next? + +- [Defining a business network](../business-network/bnd-create.html) +- [Modeling language](../reference/cto_language.html) +- [Managing your solution](./managingindex.html) diff --git a/packages/composer-website/jekylldocs/problems/diagnostics.md b/packages/composer-website/jekylldocs/problems/diagnostics.md index 3080179b23..7296c68cf2 100644 --- a/packages/composer-website/jekylldocs/problems/diagnostics.md +++ b/packages/composer-website/jekylldocs/problems/diagnostics.md @@ -2,8 +2,10 @@ layout: default title: Task - Diagnosing Problems category: tasks -sidebar: sidebars/problems.md +sidebar: sidebars/accordion-toc.md excerpt: Diagnosing Problems +section: diagnostics +index-order: 0 --- # Diagnosing Problems diff --git a/packages/composer-website/jekylldocs/reference/JSDOC-README.md b/packages/composer-website/jekylldocs/reference/JSDOC-README.md new file mode 100644 index 0000000000..76132da2bc --- /dev/null +++ b/packages/composer-website/jekylldocs/reference/JSDOC-README.md @@ -0,0 +1,34 @@ +--- +index-order: 9 +title: API Documentation +section: reference +layout: default +exception: API +excerpt: The Client, Admin, and Runtime components of Hyperledger Composer contain [JavaScript APIs](../jsdoc/index.html) for application integration. +--- + +# Hyperledger Composer API +Hyperledger Composer is an application development framework for building Blockchain applications based on Hyperledger. This is the JavaScript documentation for the Hyperledger Composer Client, Admin, and Runtime JavaScript APIs. + + +## Overview +The major components of Hyperledger Composer are: + +1. The Hyperledger Composer language for describing the structure of resources (assets, participants +and transactions) that participate in a blockchain backed business network. +2. JavaScript APIs to query, create, update and delete resources and submit transactions + from client applications. Hyperledger Composer resources are stored on the Blockchain. +3. JavaScript transaction processor functions that runs on Hyperledger Fabric when transactions are +submitted for processing. These functions may update the state of resources +stored on the Blockchain via server-side Hyperledger Composer APIs. + +## Resources + +- [Documentation](https://hyperledger.github.io/composer/) +- [npm modules](https://www.npmjs.com/search?q=hyperledger-composer) +- [GitHub repositories](https://github.com/hyperledger/composer) + +## Contributing + +To read more about the community and guidelines for submitting pull requests, +please read the [Contributing document](https://github.com/hyperledger/composer/blob/master/CONTRIBUTING.md). diff --git a/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md b/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md new file mode 100644 index 0000000000..66025787e0 --- /dev/null +++ b/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Hyperledger Composer Network logLevel +section: reference-command +sidebar: sidebars/accordion-toc.md +excerpt: Composer Network logLevel +--- + +# {{site.data.conrefs.composer_full}} Network logLevel + + +The `composer network logLevel` command is used to return or define the log level of the composer runtime. If the `newlevel` option is specified it will change the current level to the specified value. If `newlevel` is not specified, this command will return the current logging level. + +``` +composer network logLevel -n -p -l -i -s +``` + +### Options +``` +--help Show help [boolean] +-v, --version Show version number [boolean] +--businessNetworkName, -n The business network name [string] [required] +--connectionProfileName, -p The connection profile name [string] [required] +--newlevel, -l the new logging level (INFO/WARNING/ERROR/DEBUG) [string] +--enrollId, -i The enrollment ID of the user [string] [required] +--enrollSecret, -s The enrollment secret of the user [string] +``` diff --git a/packages/composer-website/jekylldocs/support/index.md b/packages/composer-website/jekylldocs/support/index.md index d4865b3b68..4eb7433540 100644 --- a/packages/composer-website/jekylldocs/support/index.md +++ b/packages/composer-website/jekylldocs/support/index.md @@ -2,8 +2,10 @@ layout: default title: Support category: start -sidebar: sidebars/support.md +sidebar: sidebars/accordion-toc.md excerpt: Get support with Hyperledger Composer +section: support +index-order: 0 --- #Community diff --git a/packages/composer-website/jekylldocs/tutorials/developer-guide.md b/packages/composer-website/jekylldocs/tutorials/developer-guide.md index 13f99c301d..4c0d163587 100644 --- a/packages/composer-website/jekylldocs/tutorials/developer-guide.md +++ b/packages/composer-website/jekylldocs/tutorials/developer-guide.md @@ -4,7 +4,7 @@ title: Developer Guide category: tutorials section: tutorials index-order: 2 -sidebar: sidebars/tutorials.md +sidebar: sidebars/accordion-toc.md excerpt: "The developer guide will walk you through the steps required to build a Hyperledger Composer blockchain solution from scratch. In the space of a day or so you should be able to go from an idea for a disruptive blockchain innovation to a complete business network, running on Hyperledger Fabric." --- diff --git a/packages/composer-website/jekylldocs/tutorials/playground-guide.md b/packages/composer-website/jekylldocs/tutorials/playground-guide.md index 5170eac4be..36629890be 100644 --- a/packages/composer-website/jekylldocs/tutorials/playground-guide.md +++ b/packages/composer-website/jekylldocs/tutorials/playground-guide.md @@ -4,7 +4,7 @@ title: Playground Guide category: tutorials section: tutorials index-order: 1 -sidebar: sidebars/tutorials.md +sidebar: sidebars/accordion-toc.md excerpt: The Playground guide runs through importing the car auction sample business network. In this guide, you'll create participants, assets, and transactions; set up and run the auction, and verify that the transactions worked correctly. If you want to run the playground guide locally [**install the Playground locally**](../installing/using-playground-locally.html) first, then use the playground guide. --- diff --git a/packages/composer-website/jekylldocs/tutorials/tutorials.md b/packages/composer-website/jekylldocs/tutorials/tutorials.md index a82b514ebb..f6b9be2bb0 100644 --- a/packages/composer-website/jekylldocs/tutorials/tutorials.md +++ b/packages/composer-website/jekylldocs/tutorials/tutorials.md @@ -3,7 +3,7 @@ layout: default title: Tutorials Index category: tutorials section: tutorials -sidebar: sidebars/tutorials.md +sidebar: sidebars/accordion-toc.md index-order: 0 excerpt: Tutorials --- From 30aa1f213e86561b7f912edd7c1b54fe3c87b07a Mon Sep 17 00:00:00 2001 From: EdProsser Date: Wed, 5 Jul 2017 17:37:15 +0100 Subject: [PATCH 2/7] ToC changes --- .../jekylldocs/applications/applications-index.md | 2 +- packages/composer-website/jekylldocs/applications/node.md | 2 +- .../jekylldocs/applications/subscribing-to-events.md | 2 +- packages/composer-website/jekylldocs/applications/web.md | 2 +- .../composer-website/jekylldocs/business-network/bnd-create.md | 2 +- .../composer-website/jekylldocs/business-network/bnd-deploy.md | 2 +- .../composer-website/jekylldocs/business-network/bnd-publish.md | 2 +- .../jekylldocs/business-network/business-network-index.md | 2 +- .../jekylldocs/business-network/businessnetworkdefinition.md | 2 +- .../jekylldocs/business-network/publishing-events.md | 2 +- packages/composer-website/jekylldocs/business-network/query.md | 2 +- .../composer-website/jekylldocs/business-network/testing.md | 2 +- .../composer-website/jekylldocs/installing/development-tools.md | 2 +- .../jekylldocs/installing/getting-started-with-playground.md | 2 +- .../composer-website/jekylldocs/installing/installing-index.md | 2 +- .../jekylldocs/installing/using-playground-locally.md | 2 +- packages/composer-website/jekylldocs/integrating/call-out.md | 2 +- .../jekylldocs/integrating/deploying-the-rest-server.md | 2 +- .../jekylldocs/integrating/enabling-rest-authentication.md | 2 +- .../jekylldocs/integrating/getting-started-rest-api.md | 2 +- .../jekylldocs/integrating/integrating-index.md | 2 +- packages/composer-website/jekylldocs/integrating/node-red.md | 2 +- .../jekylldocs/introduction/businessnetworkdefinition.md | 2 +- .../composer-website/jekylldocs/introduction/introduction.md | 2 +- .../composer-website/jekylldocs/introduction/key-concepts.md | 2 +- .../jekylldocs/introduction/solution-architecture.md | 2 +- .../composer-website/jekylldocs/managing/current-participant.md | 2 +- packages/composer-website/jekylldocs/managing/github-oauth.md | 2 +- packages/composer-website/jekylldocs/managing/identity-issue.md | 2 +- .../composer-website/jekylldocs/managing/identity-revoke.md | 2 +- packages/composer-website/jekylldocs/managing/managingindex.md | 2 +- .../composer-website/jekylldocs/managing/participant-add.md | 2 +- .../jekylldocs/managing/participantsandidentities.md | 2 +- .../composer-website/jekylldocs/managing/updating-composer.md | 2 +- packages/composer-website/jekylldocs/problems/diagnostics.md | 2 +- .../jekylldocs/reference/composer.network.logLevel.md | 2 +- packages/composer-website/jekylldocs/support/index.md | 2 +- .../composer-website/jekylldocs/tutorials/developer-guide.md | 2 +- .../composer-website/jekylldocs/tutorials/playground-guide.md | 2 +- packages/composer-website/jekylldocs/tutorials/tutorials.md | 2 +- 40 files changed, 40 insertions(+), 40 deletions(-) diff --git a/packages/composer-website/jekylldocs/applications/applications-index.md b/packages/composer-website/jekylldocs/applications/applications-index.md index 06a3bb9522..ecb4477b24 100644 --- a/packages/composer-website/jekylldocs/applications/applications-index.md +++ b/packages/composer-website/jekylldocs/applications/applications-index.md @@ -4,7 +4,7 @@ title: Developing Applications section: applications category: start index-order: 0 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/applications.md excerpt: Writing a node.js application --- diff --git a/packages/composer-website/jekylldocs/applications/node.md b/packages/composer-website/jekylldocs/applications/node.md index dc6ab503a6..47826d3a4c 100644 --- a/packages/composer-website/jekylldocs/applications/node.md +++ b/packages/composer-website/jekylldocs/applications/node.md @@ -4,7 +4,7 @@ title: Writing a Node.js application section: applications category: start index-order: 1 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/applications.md excerpt: "[**Developing Node.js applications to work with Hyperledger Composer**](./node.html) allows you to programmatically connect to a deployed business network, create, read, update and delete assets and participants and to submit transactions." --- diff --git a/packages/composer-website/jekylldocs/applications/subscribing-to-events.md b/packages/composer-website/jekylldocs/applications/subscribing-to-events.md index 3bc5fc701a..4b5f131afb 100644 --- a/packages/composer-website/jekylldocs/applications/subscribing-to-events.md +++ b/packages/composer-website/jekylldocs/applications/subscribing-to-events.md @@ -4,7 +4,7 @@ title: Subscribing to events category: tasks section: applications index-order: 3 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/applications.md excerpt: Node.js applications can [**subscribe to events from a business network**](./subscribing-to-events.html) by using the `composer-client.BusinessNetworkConnection.on` API call. Events are defined in the business network model file and are emitted by specified transactions in the transaction processor function file. --- diff --git a/packages/composer-website/jekylldocs/applications/web.md b/packages/composer-website/jekylldocs/applications/web.md index febc5a3e25..da74fabc82 100644 --- a/packages/composer-website/jekylldocs/applications/web.md +++ b/packages/composer-website/jekylldocs/applications/web.md @@ -4,7 +4,7 @@ title: Writing Web or mobile applications category: start section: applications index-order: 2 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/applications.md excerpt: Web or mobile applications that need to interact with deployed business networks should make calls to a REST API. The easiest way to create the REST API is to use the `composer-rest-server` to [**dynamically generate a REST API from the deployed business network**](./web.html). --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-create.md b/packages/composer-website/jekylldocs/business-network/bnd-create.md index e95ba8a5a5..e5283b29b2 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-create.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-create.md @@ -4,7 +4,7 @@ title: Task - Create a Business Network Definition category: tasks section: business-network index-order: 2 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: How to create a business network definition --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md index ce8923197e..2f57fa7054 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md @@ -4,7 +4,7 @@ title: Task - Deploying and Updating Business Networks category: tasks section: business-network index-order: 3 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: How to deploy or update Business Networks --- diff --git a/packages/composer-website/jekylldocs/business-network/bnd-publish.md b/packages/composer-website/jekylldocs/business-network/bnd-publish.md index 031ffdef41..43f40ebca1 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-publish.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-publish.md @@ -4,7 +4,7 @@ title: Task - Publish Models or Business Network Definitions category: tasks section: business-network index-order: 6 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: How to publish a model or business network definition for use by applications --- diff --git a/packages/composer-website/jekylldocs/business-network/business-network-index.md b/packages/composer-website/jekylldocs/business-network/business-network-index.md index ec850e2de9..c220d4ef2d 100644 --- a/packages/composer-website/jekylldocs/business-network/business-network-index.md +++ b/packages/composer-website/jekylldocs/business-network/business-network-index.md @@ -4,7 +4,7 @@ title: Hyperledger Composer - Developing Business Networks category: concepts section: business-network index-order: 0 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: Overview of Developing Business Networks --- diff --git a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md index 4b9979b646..c3b0009f05 100644 --- a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md @@ -4,7 +4,7 @@ title: Hyperledger Composer - Business Network Definition category: concepts section: business-network index-order: 1 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: Overview of the Business Network Definition --- diff --git a/packages/composer-website/jekylldocs/business-network/publishing-events.md b/packages/composer-website/jekylldocs/business-network/publishing-events.md index 6539ca2e90..caf84b3013 100644 --- a/packages/composer-website/jekylldocs/business-network/publishing-events.md +++ b/packages/composer-website/jekylldocs/business-network/publishing-events.md @@ -4,7 +4,7 @@ title: Emitting Events category: tasks section: business-network index-order: 4 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: Emitting Events from Transaction Processor Functions --- diff --git a/packages/composer-website/jekylldocs/business-network/query.md b/packages/composer-website/jekylldocs/business-network/query.md index 36beb09929..4ba7943ffc 100644 --- a/packages/composer-website/jekylldocs/business-network/query.md +++ b/packages/composer-website/jekylldocs/business-network/query.md @@ -4,7 +4,7 @@ title: Querying Business Network Data category: tasks section: business-network index-order: 7 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: Queries are used to return data about the blockchain world-state; for example, you could write a query to return all drivers over a defined age parameter, or all drivers with a specific name. --- diff --git a/packages/composer-website/jekylldocs/business-network/testing.md b/packages/composer-website/jekylldocs/business-network/testing.md index efb4122b41..193c1a2b82 100644 --- a/packages/composer-website/jekylldocs/business-network/testing.md +++ b/packages/composer-website/jekylldocs/business-network/testing.md @@ -4,7 +4,7 @@ title: Task - Testing Business Networks category: tasks section: business-network index-order: 5 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/businessnetworks.md excerpt: How to test business networks --- diff --git a/packages/composer-website/jekylldocs/installing/development-tools.md b/packages/composer-website/jekylldocs/installing/development-tools.md index 1b4df1df27..ba2753afba 100644 --- a/packages/composer-website/jekylldocs/installing/development-tools.md +++ b/packages/composer-website/jekylldocs/installing/development-tools.md @@ -3,7 +3,7 @@ layout: default title: Installing a development environment category: start section: installing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/installing.md excerpt: To install the command line and development tools, along with a local instance of Hyperledger Fabric click [**Install Development Tools**](../installing/development-tools.html) here or in the table of contents on the left. index-order: 3 --- diff --git a/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md b/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md index 8f45268dd3..2663f7d119 100644 --- a/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md +++ b/packages/composer-website/jekylldocs/installing/getting-started-with-playground.md @@ -2,7 +2,7 @@ layout: default title: Using the Playground online category: tasks -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/installing.md section: installing excerpt: To jump into the online Playground, click [**Try Online Playground**](../installing/getting-started-with-playground.html) here or in the table of contents on the left. index-order: 1 diff --git a/packages/composer-website/jekylldocs/installing/installing-index.md b/packages/composer-website/jekylldocs/installing/installing-index.md index 7460f8ba2c..bf21c2a0e7 100644 --- a/packages/composer-website/jekylldocs/installing/installing-index.md +++ b/packages/composer-website/jekylldocs/installing/installing-index.md @@ -2,7 +2,7 @@ layout: default title: Installing Index category: tasks -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/installing.md section: installing index-order: 0 excerpt: Tutorials diff --git a/packages/composer-website/jekylldocs/installing/using-playground-locally.md b/packages/composer-website/jekylldocs/installing/using-playground-locally.md index d7018c4207..cad98245a6 100644 --- a/packages/composer-website/jekylldocs/installing/using-playground-locally.md +++ b/packages/composer-website/jekylldocs/installing/using-playground-locally.md @@ -2,7 +2,7 @@ layout: default title: Installing the Playground locally category: start -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/installing.md section: installing excerpt: To run the Playground locally with a local instance of Hyperledger Fabric, click [**Install Local Playground**](../installing/using-playground-locally.html) here or in the table of contents on the left. index-order: 2 diff --git a/packages/composer-website/jekylldocs/integrating/call-out.md b/packages/composer-website/jekylldocs/integrating/call-out.md index c55f1b5d3c..1986c789d5 100644 --- a/packages/composer-website/jekylldocs/integrating/call-out.md +++ b/packages/composer-website/jekylldocs/integrating/call-out.md @@ -5,7 +5,7 @@ category: start section: integrating status: experimental index-order: 4 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: "[**Transaction processor functions can be used to call external REST services**](./call-out.html). This allows you to move complex computation off the blockchain." --- diff --git a/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md b/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md index d89a0863c3..63c4908a8b 100644 --- a/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md +++ b/packages/composer-website/jekylldocs/integrating/deploying-the-rest-server.md @@ -4,7 +4,7 @@ title: Deploying the REST server for a business network category: start section: integrating index-order: 3 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: By deploying a REST server for a business network, you can [**integrate existing systems and data with your Hyperledger Composer business network**](./deploying-the-rest-server.html), allowing you to create, update, or delete assets and participants, as well as get and submit transactions. --- diff --git a/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md b/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md index 9da0b6c80b..ff9104c8df 100644 --- a/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md +++ b/packages/composer-website/jekylldocs/integrating/enabling-rest-authentication.md @@ -4,7 +4,7 @@ title: Enabling REST API authentication for a business network category: start section: integrating index-order: 2 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: By default, the Hyperledger Composer REST server services all requests by using the Blockchain identity specified on the command line at startup. By [**enabling authentication, the identity of the client can be used to digitally sign all transactions made by that client.**](./enabling-rest-authentication.html) --- diff --git a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md index f6ef7be59c..1710ad9e8b 100644 --- a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md +++ b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md @@ -4,7 +4,7 @@ title: Generating a REST API category: start section: integrating index-order: 1 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: Hyperledger Composer includes a standalone [**Node.js process that exposes a business network as a REST API**](./getting-started-rest-api.html). The LoopBack framework is used to generate an Open API, described by a Swagger document. --- diff --git a/packages/composer-website/jekylldocs/integrating/integrating-index.md b/packages/composer-website/jekylldocs/integrating/integrating-index.md index 13ba7a5ff9..949b13b11f 100644 --- a/packages/composer-website/jekylldocs/integrating/integrating-index.md +++ b/packages/composer-website/jekylldocs/integrating/integrating-index.md @@ -4,7 +4,7 @@ title: Integrating Index category: concepts section: integrating index-order: 0 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: How to create a new Connection Profile --- diff --git a/packages/composer-website/jekylldocs/integrating/node-red.md b/packages/composer-website/jekylldocs/integrating/node-red.md index 0af33bbcb1..968a435d2f 100644 --- a/packages/composer-website/jekylldocs/integrating/node-red.md +++ b/packages/composer-website/jekylldocs/integrating/node-red.md @@ -4,7 +4,7 @@ title: Integrating with Node-RED category: integrating section: integrating index-order: 5 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/integrating.md excerpt: "[Node-RED](http://nodered.org) includes a number of [**Hyperledger Composer _nodes_ allowing you to submit transactions, read, update and delete assets and participants, and subscribe to events.**](./node-red.html)" --- diff --git a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md index 9529d795f0..78aba226b6 100644 --- a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md @@ -2,7 +2,7 @@ layout: default title: Hyperledger Composer - Business Network Definition category: concepts -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/introduction.md excerpt: Overview of the Business Network Definition --- diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index 081ae63ff2..1d5fae8f3d 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -4,7 +4,7 @@ title: Introduction category: overview section: introduction index-order: 0 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/introduction.md excerpt: Hyperledger Composer overview --- diff --git a/packages/composer-website/jekylldocs/introduction/key-concepts.md b/packages/composer-website/jekylldocs/introduction/key-concepts.md index 295e636d41..2e04897846 100644 --- a/packages/composer-website/jekylldocs/introduction/key-concepts.md +++ b/packages/composer-website/jekylldocs/introduction/key-concepts.md @@ -1,7 +1,7 @@ --- layout: default title: Key Concepts -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/introduction.md section: introduction index-order: 1 --- diff --git a/packages/composer-website/jekylldocs/introduction/solution-architecture.md b/packages/composer-website/jekylldocs/introduction/solution-architecture.md index 174ac4aeb9..746e9fcdee 100644 --- a/packages/composer-website/jekylldocs/introduction/solution-architecture.md +++ b/packages/composer-website/jekylldocs/introduction/solution-architecture.md @@ -1,7 +1,7 @@ --- layout: default title: Typical Solution Architecture -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/introduction.md section: introduction index-order: 2.5 --- diff --git a/packages/composer-website/jekylldocs/managing/current-participant.md b/packages/composer-website/jekylldocs/managing/current-participant.md index a023dcce3e..dee4c9220d 100644 --- a/packages/composer-website/jekylldocs/managing/current-participant.md +++ b/packages/composer-website/jekylldocs/managing/current-participant.md @@ -3,7 +3,7 @@ layout: default title: Implementing participant-based access control category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: Transaction processor functions can be used to [**implement participant-based access control**](../managing/current-participant.html) by checking the participant type and identifier. index-order: 6 --- diff --git a/packages/composer-website/jekylldocs/managing/github-oauth.md b/packages/composer-website/jekylldocs/managing/github-oauth.md index 3fbd4c646f..c45135aa2c 100644 --- a/packages/composer-website/jekylldocs/managing/github-oauth.md +++ b/packages/composer-website/jekylldocs/managing/github-oauth.md @@ -3,7 +3,7 @@ layout: default title: Enabling Playground OAuth with GitHub category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: By [**enabling OAuth with GitHub**](../managing/github-oauth.html), you avoid an error if the GitHub rate limit is hit. index-order: 5 --- diff --git a/packages/composer-website/jekylldocs/managing/identity-issue.md b/packages/composer-website/jekylldocs/managing/identity-issue.md index b17179a33e..6952302c88 100644 --- a/packages/composer-website/jekylldocs/managing/identity-issue.md +++ b/packages/composer-website/jekylldocs/managing/identity-issue.md @@ -3,7 +3,7 @@ layout: default title: Issuing an identity to a participant category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: "[**An identity can be issued to a participant using either the API or the command line**](../managing/identity-issue.html). Once an identity has been issued, the identity can then be used by the participant to interact with the business network in the context of that participant." index-order: 3 --- diff --git a/packages/composer-website/jekylldocs/managing/identity-revoke.md b/packages/composer-website/jekylldocs/managing/identity-revoke.md index a389df8f76..6b93d6dcf2 100644 --- a/packages/composer-website/jekylldocs/managing/identity-revoke.md +++ b/packages/composer-website/jekylldocs/managing/identity-revoke.md @@ -3,7 +3,7 @@ layout: default title: Revoking the identity of a participant category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: "[**An identity can be revoked from a participant using either the API or the command line**](../managing/identity-revoke.html). Once an identity has been revoked, the identity can no longer be used by the participant to interact with the business network in the context of that participant." index-order: 4 --- diff --git a/packages/composer-website/jekylldocs/managing/managingindex.md b/packages/composer-website/jekylldocs/managing/managingindex.md index 45044635a4..17e3bef64b 100644 --- a/packages/composer-website/jekylldocs/managing/managingindex.md +++ b/packages/composer-website/jekylldocs/managing/managingindex.md @@ -4,7 +4,7 @@ title: Managing Index category: concepts section: managing index-order: 0 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: "Managing your {{site.data.conrefs.composer_full}}" --- diff --git a/packages/composer-website/jekylldocs/managing/participant-add.md b/packages/composer-website/jekylldocs/managing/participant-add.md index 8149503a3d..994fdc133a 100644 --- a/packages/composer-website/jekylldocs/managing/participant-add.md +++ b/packages/composer-website/jekylldocs/managing/participant-add.md @@ -3,7 +3,7 @@ layout: default title: Adding participants category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: "[**Participants must be added to a business network**](../managing/participant-add.html) before they can make transactions. Participants can create assets, and also exchange assets with other participants. A participant works with assets by submitting transactions." index-order: 2 --- diff --git a/packages/composer-website/jekylldocs/managing/participantsandidentities.md b/packages/composer-website/jekylldocs/managing/participantsandidentities.md index 7821f31dc7..16c607929d 100644 --- a/packages/composer-website/jekylldocs/managing/participantsandidentities.md +++ b/packages/composer-website/jekylldocs/managing/participantsandidentities.md @@ -3,7 +3,7 @@ layout: default title: Participants and identities category: concepts section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: Participants and identities are core concepts of Hyperledger Composer. A participant is a member of business networks and might represent individuals or organizations. Participants have identity documents which can be validated to prove their identity. For more information, see [**participants and identities**](../managing/participantsandidentities.html). index-order: 1 --- diff --git a/packages/composer-website/jekylldocs/managing/updating-composer.md b/packages/composer-website/jekylldocs/managing/updating-composer.md index 6c0c9fdf90..2f2450945d 100644 --- a/packages/composer-website/jekylldocs/managing/updating-composer.md +++ b/packages/composer-website/jekylldocs/managing/updating-composer.md @@ -3,7 +3,7 @@ layout: default title: Updating Hyperledger Composer category: tasks section: managing -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/managing.md excerpt: To [update Hyperledger Composer](./updating-composer.html) to a new version, the Hyperledger Composer components must be uninstalled and reinstalled using npm. index-order: 7 --- diff --git a/packages/composer-website/jekylldocs/problems/diagnostics.md b/packages/composer-website/jekylldocs/problems/diagnostics.md index 7296c68cf2..dc3d631f65 100644 --- a/packages/composer-website/jekylldocs/problems/diagnostics.md +++ b/packages/composer-website/jekylldocs/problems/diagnostics.md @@ -2,7 +2,7 @@ layout: default title: Task - Diagnosing Problems category: tasks -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/problems.md excerpt: Diagnosing Problems section: diagnostics index-order: 0 diff --git a/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md b/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md index 66025787e0..33ecddb7ff 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.logLevel.md @@ -2,7 +2,7 @@ layout: default title: Hyperledger Composer Network logLevel section: reference-command -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/reference.md excerpt: Composer Network logLevel --- diff --git a/packages/composer-website/jekylldocs/support/index.md b/packages/composer-website/jekylldocs/support/index.md index 4eb7433540..4a0a8d7b48 100644 --- a/packages/composer-website/jekylldocs/support/index.md +++ b/packages/composer-website/jekylldocs/support/index.md @@ -2,7 +2,7 @@ layout: default title: Support category: start -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/support.md excerpt: Get support with Hyperledger Composer section: support index-order: 0 diff --git a/packages/composer-website/jekylldocs/tutorials/developer-guide.md b/packages/composer-website/jekylldocs/tutorials/developer-guide.md index 4c0d163587..13f99c301d 100644 --- a/packages/composer-website/jekylldocs/tutorials/developer-guide.md +++ b/packages/composer-website/jekylldocs/tutorials/developer-guide.md @@ -4,7 +4,7 @@ title: Developer Guide category: tutorials section: tutorials index-order: 2 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/tutorials.md excerpt: "The developer guide will walk you through the steps required to build a Hyperledger Composer blockchain solution from scratch. In the space of a day or so you should be able to go from an idea for a disruptive blockchain innovation to a complete business network, running on Hyperledger Fabric." --- diff --git a/packages/composer-website/jekylldocs/tutorials/playground-guide.md b/packages/composer-website/jekylldocs/tutorials/playground-guide.md index 36629890be..5170eac4be 100644 --- a/packages/composer-website/jekylldocs/tutorials/playground-guide.md +++ b/packages/composer-website/jekylldocs/tutorials/playground-guide.md @@ -4,7 +4,7 @@ title: Playground Guide category: tutorials section: tutorials index-order: 1 -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/tutorials.md excerpt: The Playground guide runs through importing the car auction sample business network. In this guide, you'll create participants, assets, and transactions; set up and run the auction, and verify that the transactions worked correctly. If you want to run the playground guide locally [**install the Playground locally**](../installing/using-playground-locally.html) first, then use the playground guide. --- diff --git a/packages/composer-website/jekylldocs/tutorials/tutorials.md b/packages/composer-website/jekylldocs/tutorials/tutorials.md index f6b9be2bb0..a82b514ebb 100644 --- a/packages/composer-website/jekylldocs/tutorials/tutorials.md +++ b/packages/composer-website/jekylldocs/tutorials/tutorials.md @@ -3,7 +3,7 @@ layout: default title: Tutorials Index category: tutorials section: tutorials -sidebar: sidebars/accordion-toc.md +sidebar: sidebars/tutorials.md index-order: 0 excerpt: Tutorials --- From 285845d66250ea313dc044f79a21a1eca3ddc637 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Wed, 5 Jul 2017 17:46:41 +0100 Subject: [PATCH 3/7] ToC changes --- .../jekylldocs/reference/commands.md | 4 +++ .../reference/composer.network.deploy.md | 33 +++++++++++++++---- .../jekylldocs/reference/connectionprofile.md | 1 + .../jekylldocs/reference/glossary.md | 2 +- .../jekylldocs/reference/reference-index.md | 2 +- 5 files changed, 34 insertions(+), 8 deletions(-) diff --git a/packages/composer-website/jekylldocs/reference/commands.md b/packages/composer-website/jekylldocs/reference/commands.md index 46031a7f24..c916b4c4e5 100644 --- a/packages/composer-website/jekylldocs/reference/commands.md +++ b/packages/composer-website/jekylldocs/reference/commands.md @@ -44,6 +44,10 @@ Permanently disable a business network definition: [composer network undeploy](. List the contents of a deployed Business Network: [composer network list](./composer.network.list.md) +`composer network logLevel` + +Return or update the log level for the composer runtime: [`composer network logLevel`](./composer.network.logLevel.md) + `composer network ping` Test the connection to a deployed a Business Network: [composer network ping](./composer.network.ping.md) diff --git a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md index 15ea40633d..ba8d8a199e 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md @@ -18,12 +18,15 @@ composer network deploy -a -i -s Date: Wed, 5 Jul 2017 23:11:44 +0100 Subject: [PATCH 4/7] identity issue --- .../jekylldocs/reference/composer.identity.issue.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/composer-website/jekylldocs/reference/composer.identity.issue.md b/packages/composer-website/jekylldocs/reference/composer.identity.issue.md index ea3758c2d5..9deebb694e 100644 --- a/packages/composer-website/jekylldocs/reference/composer.identity.issue.md +++ b/packages/composer-website/jekylldocs/reference/composer.identity.issue.md @@ -29,6 +29,8 @@ Options: --newUserId, -u The user ID for the new identity [string] [required] --participantId, -a The particpant to issue the new identity to [string] [required] --issuer, -x If the new identity should be able to issue other new identities [boolean] [required] + --option, -o Options that are specific specific to a connection. Multiple options are specified by repeating this option [string] + --optionFile, -O A file containing options that are specific to connection [string] ``` ## Options From bdbd662f658fc71ca21bd9b41adf734a81f95994 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Thu, 6 Jul 2017 07:50:01 +0100 Subject: [PATCH 5/7] TOC Update --- .../composer-website/jekylldocs/_includes/sidebars/managing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md index d7f3ebf1ba..f7bafc398f 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md @@ -11,6 +11,7 @@ - [Revoking an identity from a participant](../managing/identity-revoke.html) - [Enabling OAuth using GitHub](../managing/github-oauth.html) - [Enabling access control using the current participant](../managing/current-participant.html) + - [Updating {{site.data.conrefs.composer_full}}](../managing/updating-composer.html) - [Diagnosing Problems](../problems/diagnostics.html) - [Reference](../reference/reference-index.html) - [Support](../support/index.html) From 57885f1a543bd5dce2c080f1d90055e2c70b6610 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Thu, 6 Jul 2017 10:15:25 +0100 Subject: [PATCH 6/7] Beta->RC --- .../jekylldocs/business-network/bnd-deploy.md | 8 ++++---- .../jekylldocs/business-network/query.md | 2 +- .../jekylldocs/installing/development-tools.md | 4 ++-- .../jekylldocs/installing/using-playground-locally.md | 10 +++++----- .../jekylldocs/introduction/solution-architecture.md | 2 +- .../jekylldocs/reference/connectionprofile.md | 6 +++--- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md index 2f57fa7054..51e43ee2ff 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-deploy.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-deploy.md @@ -22,17 +22,17 @@ For example: To update the definition of an already deployed business network use the `composer network update` CLI command. -## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0 Beta 1 +## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0 RC 1 -In {{site.data.conrefs.hlf_full}} v1.0 Beta 1 peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret. +In {{site.data.conrefs.hlf_full}} v1.0 RC 1 peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret. When connecting to the peer you must use an identity (certificate) where the Common Name (CN) contains the text `admin`, for example, `PeerAdmin`, `myadmin`, `Admin` or `AdminPeer` are all valid Common Names. 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. -Due to many breaking API changes between {{site.data.conrefs.hlf_full}} alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 Beta 1, {{site.data.conrefs.composer_full}} only supports the beta 1 level and 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}} alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 RC 1, {{site.data.conrefs.composer_full}} only supports the RC 1 level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1). ### Deploying business networks using Playground locally -When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 Beta 1 using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity. +When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 RC 1 using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity. ## References diff --git a/packages/composer-website/jekylldocs/business-network/query.md b/packages/composer-website/jekylldocs/business-network/query.md index 4ba7943ffc..3fe3c2894d 100644 --- a/packages/composer-website/jekylldocs/business-network/query.md +++ b/packages/composer-website/jekylldocs/business-network/query.md @@ -16,7 +16,7 @@ Queries are used to return data about the blockchain world-state; for example, y Queries are an optional component of a business network definition, written in a single query file (`queries.qry`). -Note: Queries are supported by the {{site.data.conrefs.hlf_full}} v1.0, embedded and web runtimes. The query support for the embedded and web runtimes currently has limitations and is unstable. When using the {{site.data.conrefs.hlf_full}} v1.0-beta runtime {{site.data.conrefs.hlf_full}} must be configured to use CouchDB persistence. Queries are **not** supported with the {{site.data.conrefs.hlf_full}} v0.6 runtime. +Note: Queries are supported by the {{site.data.conrefs.hlf_full}} v1.0, embedded and web runtimes. The query support for the embedded and web runtimes currently has limitations and is unstable. When using the {{site.data.conrefs.hlf_full}} v1.0-RC runtime {{site.data.conrefs.hlf_full}} must be configured to use CouchDB persistence. Queries are **not** supported with the {{site.data.conrefs.hlf_full}} v0.6 runtime. ## Writing Queries diff --git a/packages/composer-website/jekylldocs/installing/development-tools.md b/packages/composer-website/jekylldocs/installing/development-tools.md index ba2753afba..40daeb6c5b 100644 --- a/packages/composer-website/jekylldocs/installing/development-tools.md +++ b/packages/composer-website/jekylldocs/installing/development-tools.md @@ -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-beta. The default is for v1.0-beta and we suggest this is the one you use. +There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0-RC. The default is for v1.0-RC and we suggest this is the one you use. ## Before you begin @@ -107,7 +107,7 @@ docker rmi $(docker images dev-* -q) export FABRIC_VERSION=hlfv0.6 - {{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 + {{site.data.conrefs.hlf_full}} v1.0-RC is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command export FABRIC_VERSION=hlfv1 diff --git a/packages/composer-website/jekylldocs/installing/using-playground-locally.md b/packages/composer-website/jekylldocs/installing/using-playground-locally.md index cad98245a6..590e030b98 100644 --- a/packages/composer-website/jekylldocs/installing/using-playground-locally.md +++ b/packages/composer-website/jekylldocs/installing/using-playground-locally.md @@ -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 Beta 1. +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 RC 1. {{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. @@ -39,17 +39,17 @@ docker images -aq | xargs docker rmi -f 2. Access your local {{site.data.conrefs.composer_full}} Playground by clicking this link: http://localhost:8080. -## Deploying business networks to {{site.data.conrefs.hlf_full}} Beta +## Deploying business networks to {{site.data.conrefs.hlf_full}} RC -In {{site.data.conrefs.hlf_full}} Beta peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret. +In {{site.data.conrefs.hlf_full}} RC peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret. When connecting to the peer you must use an identity (certificate) where the Common Name (CN) contains the text `admin`, for example, `PeerAdmin`, `myadmin`, `Admin` or `AdminPeer` are all valid Common Names. 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. -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). +Due to many breaking API changes between {{site.data.conrefs.hlf_full}} v1.0 alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 RC, {{site.data.conrefs.composer_full}} only supports the RC level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1). ### Deploying business networks using Playground locally -When deploying a business network to {{site.data.conrefs.hlf_full}} Beta using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity. +When deploying a business network to {{site.data.conrefs.hlf_full}} RC using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity. --- diff --git a/packages/composer-website/jekylldocs/introduction/solution-architecture.md b/packages/composer-website/jekylldocs/introduction/solution-architecture.md index 746e9fcdee..4a15228418 100644 --- a/packages/composer-website/jekylldocs/introduction/solution-architecture.md +++ b/packages/composer-website/jekylldocs/introduction/solution-architecture.md @@ -30,7 +30,7 @@ index-order: 2.5 {{site.data.conrefs.composer_full}} has been designed to support different pluggable runtimes, and currently has four runtime implementations: * {{site.data.conrefs.hlf_full}} version 0.6. State is stored on the distributed ledger. -* {{site.data.conrefs.hlf_full}} version 1.0 beta 1. State is stored on the distributed ledger. +* {{site.data.conrefs.hlf_full}} version 1.0 RC 1. State is stored on the distributed ledger. * Web, which executes within a web page, and is used by Playground. State is stored in browser local storage. * Embedded, which executes within a Node.js process, and is used primarily for unit testing business logic. State is stored in an in-memory key-value store. diff --git a/packages/composer-website/jekylldocs/reference/connectionprofile.md b/packages/composer-website/jekylldocs/reference/connectionprofile.md index d1f2cc7a44..ad6727e166 100644 --- a/packages/composer-website/jekylldocs/reference/connectionprofile.md +++ b/packages/composer-website/jekylldocs/reference/connectionprofile.md @@ -4,7 +4,7 @@ title: Connection Profiles section: reference index-order: 6 sidebar: sidebars/reference.md -excerpt: In order to connect your business network to a fabric, you must [**define a connection profile**](./connectionprofile.html). Connection profiles contain the information necessary to connect to a fabric. This topic contains example connection profiles for Hyperledger Fabric v0.6 and v1.0-beta. +excerpt: In order to connect your business network to a fabric, you must [**define a connection profile**](./connectionprofile.html). Connection profiles contain the information necessary to connect to a fabric. This topic contains example connection profiles for Hyperledger Fabric v0.6 and v1.0-RC. --- # Connection Profiles @@ -36,7 +36,7 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t "peerURL": , "eventHubURL": } - If you are creating a connection profile for {{site.data.conrefs.hlf_full}} v1.0 beta, use the following format: + If you are creating a connection profile for {{site.data.conrefs.hlf_full}} v1.0 RC, use the following format: { "type": "hlfv1", @@ -106,7 +106,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-beta 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-RC 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. From 63f07106719697903622adb0e24f7c7194bda488 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Thu, 6 Jul 2017 10:20:59 +0100 Subject: [PATCH 7/7] network deploy changes --- .../reference/composer.network.deploy.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md index ba8d8a199e..9e17dbbe64 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md @@ -47,14 +47,27 @@ The `--option, -o` option and the `--optionsFile, -O` option allow connection sp - Using the `-o` option, the endorsement policy can be sent as a single-line JSON string as follows: - composer network deploy -o endorsementPolicy='{"endorsementPolicy": {"identities": [.... }' + composer network deploy -o endorsementPolicy='{"identities": [.... }' - Using the `-o` option, the endorsement policy can be sent as a file path as follows: composer network deploy -o endorsementPolicyFile=/path/to/file/endorsementPolicy.json + In this case, the endorsement policy file should follow this format: + + {"identities":[...], + "policy": {...}} + - Using the `-O` option, the endorsement policy can be sent as a file path as follows: composer network deploy -O /path/to/file/options.json + In this case, the options file should follow this format: + + {"endorsementPolicy": {"Identities": [...]. + "policy: {...}" + }, + "someOtherOption": "A Value" + } + For more information on writing {{site.data.conrefs.hlf_full}} endorsement policies, see the [{{site.data.conrefs.hlf_full}} node SDK documentation](https://fabric-sdk-node.github.io/global.html#Policy).