From aadf9d66861ad28451cf70fcea378daa48681800 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 11 Apr 2017 16:33:01 +0100 Subject: [PATCH 01/33] Updates for work --- .../_includes/sidebars/businessnetworks.md | 4 +- .../_includes/sidebars/installing.md | 2 +- .../_includes/sidebars/introduction.md | 4 +- .../jekylldocs/_includes/sidebars/managing.md | 3 +- .../business-network/businessnetwork.md | 2 +- .../businessnetworkdefinition.md | 26 +++++++ .../business-network/deploybusinessnetwork.md | 6 +- .../jekylldocs/installing/installingindex.md | 25 +++++++ .../jekylldocs/installing/quickstart.md | 18 ++++- .../jekylldocs/introduction/introduction.md | 14 +++- .../jekylldocs/introduction/key-concepts.md | 75 +++++++++++++++++++ .../jekylldocs/managing/managingindex.md | 21 ++++++ .../managing/participantsandidentities.md | 69 +++++++++++++++++ .../tutorials/getting-started-cmd-line.md | 8 +- .../jekylldocs/tutorials/tutorialindex.md | 11 ++- 15 files changed, 265 insertions(+), 23 deletions(-) create mode 100644 packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md create mode 100644 packages/composer-website/jekylldocs/installing/installingindex.md create mode 100644 packages/composer-website/jekylldocs/introduction/key-concepts.md create mode 100644 packages/composer-website/jekylldocs/managing/managingindex.md create mode 100644 packages/composer-website/jekylldocs/managing/participantsandidentities.md diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md index 7e7a26773d..01aabdd26f 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md @@ -2,7 +2,9 @@ **[Tutorials](../tutorials/tutorialindex.html)** **[Installing](../installing/prerequisites.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** -[Defining a business network definition](../business-network/getting-started-coding-bnd.html) +[What is a business network?](../business-network/businessnetwork.html) +[What is a business network definition?](../business-network/businessnetworkdefinition.html) +[Defining a business network](../business-network/getting-started-coding-bnd.html) [Deploying a business network](../business-network/deploybusinessnetwork.html) [Create a business network definition](../business-network/bnd-define.html) [Publish a business network definition](../business-network/bnd-publish.html) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md index 7f68e7ab34..30736c885d 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** [Prerequisites](../installing/prerequisites.html) [Quickstart](../installing/quickstart.html) [Start a Fabric runtime](../installing/runtime-start.html) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md index 9a02bfd24f..c13e39876d 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md @@ -1,7 +1,5 @@ **[Introduction](../introduction/introduction.html)** -[Understanding Business Networks](../introduction/businessnetwork.html) -[Business Network Definition](../introduction/businessnetworkdefinition.html) -[Participants and Transactions](../introduction/participantsandidentities.html) +[Components and Concepts](../introduction/key-concepts.html) **[Tutorials](../tutorials/tutorialindex.html)** **[Installing](../installing/prerequisites.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md index 02b6b8b393..380d5d30b9 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md @@ -4,7 +4,8 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** +[Participants and Identities](../managing/participantsandidentities.html) [Adding a participant](../managing/participant-add.html) [Issuing an identity to a participant](../managing/identity-issue.html) [Revoking an identity from a participant](../managing/identity-revoke.html) diff --git a/packages/composer-website/jekylldocs/business-network/businessnetwork.md b/packages/composer-website/jekylldocs/business-network/businessnetwork.md index 19c7d5129b..52d5b12734 100644 --- a/packages/composer-website/jekylldocs/business-network/businessnetwork.md +++ b/packages/composer-website/jekylldocs/business-network/businessnetwork.md @@ -42,7 +42,7 @@ Fabric Composer makes it easy to create these elements in a business network, an ## Related Concepts -[Business Network Definition](../introduction/businessnetworkdefinition.html) +[Business Network Definition](../business-network/businessnetworkdefinition.html) ## Related Tasks diff --git a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md new file mode 100644 index 0000000000..6350a18e67 --- /dev/null +++ b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md @@ -0,0 +1,26 @@ +--- +layout: default +title: Fabric Composer - Business Network Definition +category: concepts +sidebar: sidebars/businessnetworks.md +excerpt: Overview of the Business Network Definition +--- + +# Business Network Definition + +--- + +Business Network Definitions are a key concept of the Fabric Composer programming model. They are represented by the `BusinessNetworkDefinition` class, defined in the `composer-common` module and exported by both `composer-admin` and `composer-client`. + +Business Network Definitions are composed of: + +* a set of model files +* a set of Javascript files + +The model files defined the business domain for a business network, while the Javascript files contain transaction processor functions. The transaction processor functions run on a Hyperledger Fabric and have access to the asset registries that are stored in the world state of the Hyperledger Fabric blockchain. + +The model files are typically created by business analysts, as they define the structure and relationships between model elements: assets, participants and transactions. + +The Javascript files are typically created by developers who are implementing business requirements provided by business analysts. + +Once defined, a Business Network Definition can be packaged into an archive using the `composer` command line interface. These archives can then be deployed, undeployed or updated on a Fabric, using the `AdminConnection` class from the `composer-admin` module. diff --git a/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md b/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md index 85bd7d3b57..b0e3a9c04f 100644 --- a/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md +++ b/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md @@ -13,7 +13,7 @@ excerpt: How to deploy a Business Network A business network is deployed using the `composer network deploy` command. ## Procedure -1. Before deploying a business network, a [Business Network Definition](../introduction/businessnetworkdefinition.html) is needed as a `zip` file with the following structure: +1. Before deploying a business network, a [Business Network Definition](../business-network/businessnetworkdefinition.html) is needed as a `zip` file with the following structure: ``` BusinessNetworkArchive.zip @@ -26,13 +26,13 @@ A business network is deployed using the `composer network deploy` command. - **lib** contains all of the transactions processor functions - **models** contains all of the model files written in the [CTO Language](../reference/cto_language.html). - - **package.json** is required, and is used to create the [Business Network Definition](../introduction/businessnetworkdefinition.html)'s identifier + - **package.json** is required, and is used to create the [Business Network Definition](../business-network/businessnetworkdefinition.html)'s identifier You can use the `composer archive` command to create an archive with the correct format. **NOTE**: *Do not zip a a folder containing **lib**, **models**, and **package.json** to create an Business Network Archive, zip the contents themselves* -2. Start [Hyperledger Fabric Peer and Membership Service](../installing/runtime-start.md) +2. Start [Hyperledger Fabric Peer and Membership Service](runtime-start.md) 3. [Create a Connection Profile](../installing/createconnectionprofile.html) or do *not* use `-p` and allow Fabric Composer to create a `Default Connection Profile` for you. diff --git a/packages/composer-website/jekylldocs/installing/installingindex.md b/packages/composer-website/jekylldocs/installing/installingindex.md new file mode 100644 index 0000000000..22888e6787 --- /dev/null +++ b/packages/composer-website/jekylldocs/installing/installingindex.md @@ -0,0 +1,25 @@ +--- +layout: default +title: Installing Fabric Composer +sidebar: sidebars/installing.md +excerpt: Installing Fabric Composer +--- + +# Installing {{site.data.conrefs.composer_full}} + +--- + +There are two ways to install {{site.data.conrefs.composer_short}}. To model, develop, or test business networks, [install the {{site.data.conrefs.composer_short}} Playground locally](../tutorials/getting-started-playground.html) or [use the playground online](https://composer-playground.mybluemix.net). + +If you want to develop and test applications, connect to a running {{site.data.conrefs.hyperledger_fabric_full}} instance, or run {{site.data.conrefs.composer_full}} and {{site.data.conrefs.hyperledger_fabric_full}} locally, see [installing {{site.data.conrefs.composer_full}}](../installing/quickstart.html). + +If you want a more guided "Getting Started" experience, see our [Tutorials and Getting Started guides](../tutorials/tutorialindex.html). + +--- + +## Related Links +* [Installing the Playground locally](../tutorials/getting-started-playground.html) +* [Run the Playground online](../tutorials/) +* [Installation Pre-Requisites](../installing/prerequisites.html) +* [Installing {{site.data.conrefs.composer_full}}](../installing/quickstart.html) +* [Tutorials and Getting Started](../tutorials/tutorialindex.html) diff --git a/packages/composer-website/jekylldocs/installing/quickstart.md b/packages/composer-website/jekylldocs/installing/quickstart.md index 3ee861bfc9..eb9ea34a43 100644 --- a/packages/composer-website/jekylldocs/installing/quickstart.md +++ b/packages/composer-website/jekylldocs/installing/quickstart.md @@ -7,10 +7,26 @@ excerpt: Quickstart --- -# Fabric Composer Quickstart +# Installing {{site.data.conrefs.composer_full}} --- +**shortdesc** + +--- + +## Before you begin + +Ensure that you have the following prerequisites installed. + +* At least Ubuntu Linux v14.04 or Mac OS v10.12 +* At least *Docker* v1.12.5 +* At least *Docker-compose* v1.10.0 +* At least *node.js*: v6.9.5 +* A code editor, for example *Atom* or *VSCode* + + + Check that your system has the required software (at the required versions) installed: **Operating Systems:** Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12 diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index 8fc621ec47..36af099d0e 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -12,12 +12,14 @@ excerpt: Fabric Composer overview --- -You can use Fabric Composer to easily define your business network, creating and tracking assets and performing transactions. Business networks represent an economic network made up of participants, assets, and the transactions that are performed between them. Assets are tangible or intangible goods, services, or property, and are stored in registries. Transactions are operations which may transform, create, and transfer assets or participants. Participants can interact with multiple business networks and maintain assets as they move between them using set identities. - -Applications can consume the data from business networks, providing end users with simple and controlled access points to the business network. Business networks can also be integrated with existing systems to create assets, transactions, and participants based on existing data. +You can use Fabric Composer to rapidly develop and deploy a blockchain solution; modeling your business network and integrating existing systems and data. Fabric Composer requires and exploits the existing [Hyperledger Fabric blockchain](https://hyperledger.org) technology, using the blockchain consensus protocol to ensure that transactions are validated by business network participants. +Applications can consume the data from business networks, providing end users with simple and controlled access points. Existing data can also be integrated you modeled network, allowing complex systems and solutions to contribute data and . + +You can use Fabric Composer to quickly model your business network, containing your existing assets and the transactions related to them, whether your assets are tangible or intangible goods, services, or property. As part of your business network model, you define the transactions which are used to interact with assets. Business networks also include the participants who interact with them, each of which can be associated with a unique identity across multiple business networks. + --- ## Key Fabric Composer concepts diagram @@ -30,9 +32,13 @@ Fabric Composer requires and exploits the existing [Hyperledger Fabric blockchai ## How does Fabric Composer work in practise? +<<<<<<< HEAD +For an example of a business network in action; a realtor can quickly model their business network; including houses and listings assets, buyers and homeowners as participants, and buying or selling houses, and creating and closing listings as transactions. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor can then create an application to present buyers and sellers with a simple user interface for viewing open listings and making offers. This business network could also be integrated with existing inventory system, adding new houses as assets and removing sold properties. Relevant other parties can be registered as participants, for example a land registry might interact with a buyer to transfer ownership of the land. +======= --- For an example of a business network in action; a realtor may have a business network containing houses and listings as assets. Participants could include buyers and homeowners. Transactions might include buying or selling houses, and creating and closing listings. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor may want to create an application to present buyers and sellers participants with a simple user interface for viewing open listings and making offers. This business network could also be integrated with the existing inventory system for the realtor, allowing for the addition of new houses as assets. Relevant other parties can be registered as participants whilst maintaining their own business network, for example a land registry might interact with a buyer winner to transfer ownership of the land. +>>>>>>> refs/remotes/fabric-composer/master --- @@ -40,4 +46,4 @@ For an example of a business network in action; a realtor may have a business ne --- -To get started with Fabric Composer right away, try the [Fabric Composer tutorials](../tutorials/tutorialindex.html), to learn more about Fabric Composer read [understanding business networks](../introduction/businessnetwork.html), to get installed and trying the full product immediately go to [installing Fabric Composer](../installing/prerequisites.html). +To get started with Fabric Composer right away, try the [Fabric Composer tutorials](../tutorials/tutorialindex.html), to learn more about Fabric Composer read [understanding Fabric Composer](../introduction/key-concepts.html), to get installed and trying the full product immediately go to [installing Fabric Composer](../installing/prerequisites.html). diff --git a/packages/composer-website/jekylldocs/introduction/key-concepts.md b/packages/composer-website/jekylldocs/introduction/key-concepts.md new file mode 100644 index 0000000000..7d0f8daa11 --- /dev/null +++ b/packages/composer-website/jekylldocs/introduction/key-concepts.md @@ -0,0 +1,75 @@ +--- +layout: default +title: Key Concepts in Fabric Composer +sidebar: sidebars/introduction.md +excerpt: +--- + +# Features and Concepts in {{site.data.conrefs.composer_full}} + +--- + +Fabric Composer 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**. + +--- + +## Framework Features + +| Component | Description | +|:---------:|:-----------:| +| composer-admin, composer-client, composer-common | Composer-admin, composer-client, and composer-common contain the APIs to interact with a {{site.data.conrefs.composer_full}} runtime. Composer-admin contains APIs for deploying and updating a business network, composer-client contains APIs for manipulating resources within registries via transactions. | +| composer-cli | Composer-cli contains | +| composer-runtime | There are several versions of the composer-runtime designed for different environments. The embedded runtime runs within local storage, the hlf and hlfv1 runtimes run on {{site.data.conrefs.hyperledger_fabric_full}} versions 0.6 and 1.0. | +| composer-connector | The composer-connector components connect your {{site.data.conrefs.composer_short}} to a {{site.data.conrefs.hyperledger_fabric_full}} instance. | +| composer-rest-server | The composer-rest-server component creates and connects you to a REST API interface containing APIs for interacting with your business network. | +| generator-fabric-composer | The generator-fabric-composer component contains a Yeoman module for generating applications using data from your business network. | +| loopback-connector-composer | The loopback-connector-composer component allows you to connect loopback-compatible systems to your {{site.data.conrefs.composer_short}} business network. | + +--- + +## Key Concepts in {{site.data.conrefs.composer_full}} + +### Blockchain State Storage + +The current state of assets and participants are stored on the blockchain, administered by {{site.data.conrefs.hyperledger_fabric_full}}. {{site.data.conrefs.hyperledger_fabric_full}} runs consensus checks to ensure the validity of all blocks in the blockchain. For more information on {{site.data.conrefs.hyperledger_fabric_full}} consensus, see the [{{site.data.conrefs.hyperledger_fabric_full}} documentation](https://hyperledger-fabric.readthedocs.io/en/latest/fabric_model.html#consensus). + +--- + +### Assets + +Assets are tangible or intangible goods, services, or property, and are stored in registries. Assets can represent almost anything in a business network, for example, a house for sale, the sale listing, the land registry certificate for that house, and the insurance documents for that house may all be assets in one or more business networks. + +Assets must have a unique identifier, but other than that, they can contain whatever properties you define. + +--- + +### Participants + +Participants are members of a business network. Participant types can be defined and limited by an access control document which makes up part of the business network definition. + +--- + +### Transactions + +Transactions are the mechanism by which participants interact with assets. This could be as simple as a participant placing a bid on a asset in an auction, or an auctioneer marking an auction closed, automatically transferring ownership of the asset to the highest bidder. + +--- + +### APIs + +The `composer-admin`, `composer-client`, and `composer-common` components contain the APIs to interact with a {{site.data.conrefs.composer_full}} runtime. The `composer-rest-server` component generates a unique RESTful API for interacting with your deployed business network. + +--- + diff --git a/packages/composer-website/jekylldocs/managing/managingindex.md b/packages/composer-website/jekylldocs/managing/managingindex.md new file mode 100644 index 0000000000..f208b46a4a --- /dev/null +++ b/packages/composer-website/jekylldocs/managing/managingindex.md @@ -0,0 +1,21 @@ +--- +layout: default +title: Integrating existing systems +category: concepts +sidebar: sidebars/managing.md +excerpt: Managing your {{site.data.conrefs.composer_full}} +--- + +# Managing your {{site.data.conrefs.composer_full}} Solution + +--- + +Operating a business network may require management tasks, for information on how to add participants, issue or revoke identities, enable OAuth authentication, and enabling access control, see the following topics. + +--- +* [What are participants and identities](../managing/participantsandidentities.html) +* [Adding a participant](../managing/participant-add.html) +* [Issuing an identity](../managng/identity-issue.html) +* [Revoking an identity](../managing/identity-revoke.html) +* [Enabling OAuth with GitHub](../managing/github-oauth.html) +* [Enabling access control as a set participant](current-participant.html) diff --git a/packages/composer-website/jekylldocs/managing/participantsandidentities.md b/packages/composer-website/jekylldocs/managing/participantsandidentities.md new file mode 100644 index 0000000000..84945ed08c --- /dev/null +++ b/packages/composer-website/jekylldocs/managing/participantsandidentities.md @@ -0,0 +1,69 @@ +--- +layout: default +title: Fabric Composer - Participants and Identities +category: concepts +sidebar: sidebars/managing.md +excerpt: Business Network +--- + +# Participants and Identities + +--- + +A `Participant` is an actor in a business network. A participant might be an +individual or an organization. A participant can create assets, and also exchange +assets with other participants. A participant works with assets by submitting transactions. + +A participant has a set of `Identity` documents that can be validated to prove the +identity of that participant. For example, an individual may have one or more of +the following identity documents that prove who they are: + +* Passport +* Driving license +* Fingerprints +* Retina scan +* SSL certificate + +In order for a new participant to join a business network, a new instance of that +participant must be created in the business network. An identity document must +then be `Issued` to that participant. The new participant can then use that identity +document to interact with the business network. + +Identity documents usually expire after a set period of time. Identity documents may +also be lost or stolen. If the identity document expires, or if it needs to be +replaced, then it must be `Revoked` so it can no longer be used to interact with +the business network. + +These actions are performed by an existing participant in the business network, +for example a regulatory body, or a participant in the same organization who has +been trusted to manage participants/identities in that organization. + +In {{site.data.conrefs.composer_full}}, the structure of a participant is modelled in a +model file. This structure may include various information about the participant, +for example the participants name, address, e-mail address, date of birth, etc. +New instances of that modelled participant can then be created and stored in a +participant registry. + +{{site.data.conrefs.composer_full}} uses Hyperledger Fabric enrollment certificates as +identity documents. APIs and command line applications are provided to issue and +revoke enrollment certificates to participants that are stored in a participant +registry. When transactions are submitted using those enrollment certificates, the +participant is identified and is made available for the transaction processor +function to use. + +## Related Concepts + +[Business Network](../introduction/businessnetwork.html) + +## Related Tasks + +[Create a Business Domain Model](../business-network/model-define.html) +[Add a Participant](../managing/participant-add.html) +[Issue an Identity to a Participant](../managing/identity-issue.html) +[Revoke an Identity from a Participant](../managing/identity-revoke.html) + +## Related Reference + +[Participant add command](../reference/participant-add.html) +[Identity issue command](../reference/identity-issue.html) +[Identity revoke command](../reference/identity-revoke.html) diff --git a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md index af923b83a2..3b12738e26 100644 --- a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md +++ b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md @@ -62,7 +62,7 @@ All the resources and scripts you'll need are in a git repository that we'll clo The first thing to do is to ensure that you have a suitable system ready for development. -**Ensure that you have followed the steps in our [Quickstart](../installing/quickstart.md) before continuing!** +**Ensure that you have followed the steps in our [Quickstart](./quickstart.md) before continuing!** Let's go ahead and make a change to start to show how easy it is to develop with Fabric Composer. @@ -226,8 +226,8 @@ We have downloaded the Hyperledger docker containers and stated a fabric. We hav If you want to continue exploring, check out our other Getting Started guides: -[Coding a Business Network Definition](../business-network/getting-started-coding-bnd.md) +[Coding a Business Network Definition](./getting-started-coding-bnd.md) -[Generating a REST API](../integrating/getting-started-rest-api.md) +[Generating a REST API](./getting-started-rest-api.md) -[Writing a Node.js App](../applications/getting-started-nodejs-app.md) +[Writing a Node.js App](./getting-started-nodejs-app.md) diff --git a/packages/composer-website/jekylldocs/tutorials/tutorialindex.md b/packages/composer-website/jekylldocs/tutorials/tutorialindex.md index a59b89bea1..3622157f8a 100644 --- a/packages/composer-website/jekylldocs/tutorials/tutorialindex.md +++ b/packages/composer-website/jekylldocs/tutorials/tutorialindex.md @@ -28,10 +28,13 @@ These getting started guides are intended for more technical users and may requi * [Quickstart](../installing/quickstart.html) installs and tests the prerequisites for the digital property network sample. * [Running a sample with the command line](../tutorials/getting-started-cmd-line.html). -* [Installing and running the {{site.data.conrefs.composer_short}} Playground locally](../tutorials/getting-started-playground.html). To run the [business network tutorial](../tutorials/defining-a-business-network.html) locally, install the playground locally first. +* [Installing and running the {{site.data.conrefs.composer_short}} Playground locally](../tutorials/getting-started-playground.html). To run the [business network tutorial](../tutorials/defining-a-business-network.html) locally, install the playground locally first. -{% for page in site.tutorials %} + From b8aa84cee195f698bf37f865b7ce12de142dc402 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Mon, 24 Apr 2017 12:02:12 +0100 Subject: [PATCH 02/33] Adding Installing Index to ToC --- .../jekylldocs/_includes/sidebars/applications.md | 2 +- .../jekylldocs/_includes/sidebars/businessnetworks.md | 2 +- .../jekylldocs/_includes/sidebars/integrating.md | 2 +- .../jekylldocs/_includes/sidebars/introduction.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/managing.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/problems.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/reference.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/support.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/tutorials.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/applications.md b/packages/composer-website/jekylldocs/_includes/sidebars/applications.md index aa196ed120..8f7c601e67 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/applications.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/applications.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** [Generating a starter application](../applications/genapp.html) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md index 01aabdd26f..388cca24cd 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** [What is a business network?](../business-network/businessnetwork.html) [What is a business network definition?](../business-network/businessnetworkdefinition.html) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md b/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md index bd170ba7e8..f93a14d8e0 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md index c13e39876d..c159cf857e 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md @@ -1,7 +1,7 @@ **[Introduction](../introduction/introduction.html)** [Components and Concepts](../introduction/key-concepts.html) **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md index 380d5d30b9..c41d91cb52 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/managing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/managing.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/problems.md b/packages/composer-website/jekylldocs/_includes/sidebars/problems.md index f829216cac..ad09d531ce 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/problems.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/problems.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/reference.md b/packages/composer-website/jekylldocs/_includes/sidebars/reference.md index 1ce9b92dc1..7db2381284 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/reference.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/reference.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/support.md b/packages/composer-website/jekylldocs/_includes/sidebars/support.md index ec30ffc4ca..9829c70a19 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/support.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/support.md @@ -1,6 +1,6 @@ **[Introduction](../introduction/introduction.html)** **[Tutorials](../tutorials/tutorialindex.html)** -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md b/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md index e4f8935da8..95a2209701 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md @@ -3,7 +3,7 @@ [Tutorial 1: Building your first business network](../tutorials/defining-a-business-network.html) [Getting started with the command line](../tutorials/getting-started-cmd-line.html) [Getting started with the playground](../tutorials/getting-started-playground.html) -**[Installing](../installing/prerequisites.html)** +**[Installing](../installing/installingindex.html)** **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** From 02c32b89ac446476707dd5ef835bbfc9959a2e84 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Mon, 24 Apr 2017 17:34:03 +0100 Subject: [PATCH 03/33] Removing Fabric Composer name --- .../composer-website/jekylldocs/_config.yml | 2 +- .../jekylldocs/_data/conrefs.yml | 2 +- .../jekylldocs/_includes/head.html | 4 +- .../jekylldocs/_includes/header.html | 2 +- .../jekylldocs/_layouts/support.html | 4 +- .../jekylldocs/applications/genapp.md | 10 ++--- .../getting-started-nodejs-app.md | 18 ++++---- .../jekylldocs/applications/index.md | 8 ++-- .../applications/rest-api-server.md | 4 +- .../jekylldocs/business-network/bnd-define.md | 18 ++++---- .../business-network/businessnetwork.md | 6 +-- .../businessnetworkdefinition.md | 4 +- .../business-network/deploybusinessnetwork.md | 2 +- .../getting-started-coding-bnd.md | 6 +-- .../business-network/model-define.md | 6 +-- .../composer-website/jekylldocs/index.html | 2 +- .../installing/createconnectionprofile.md | 2 +- .../jekylldocs/installing/installingindex.md | 4 +- .../jekylldocs/installing/quickstart.md | 4 +- .../integrating/getting-started-rest-api.md | 8 ++-- .../introduction/businessnetwork.md | 6 +-- .../introduction/businessnetworkdefinition.md | 4 +- .../jekylldocs/introduction/introduction.md | 20 ++++----- .../jekylldocs/introduction/key-concepts.md | 4 +- .../introduction/participantsandidentities.md | 2 +- .../jekylldocs/managing/identity-issue.md | 2 +- .../jekylldocs/managing/identity-revoke.md | 2 +- .../managing/participantsandidentities.md | 2 +- .../jekylldocs/overview/overview.md | 20 ++++----- .../jekylldocs/problems/diagnostics.md | 6 +-- .../jekylldocs/reference/MeetTheModules.md | 6 +-- .../jekylldocs/reference/acl_language.md | 10 ++--- .../jekylldocs/reference/commands.md | 10 ++--- .../reference/composer.archive.create.md | 4 +- .../reference/composer.archive.list.md | 4 +- .../reference/composer.generator.create.md | 2 +- .../reference/composer.generator.md | 2 +- .../reference/composer.generator.tests.md | 4 +- .../reference/composer.identity.issue.md | 4 +- .../reference/composer.identity.revoke.md | 4 +- .../reference/composer.network.deploy.md | 4 +- .../reference/composer.network.list.md | 4 +- .../reference/composer.network.ping.md | 4 +- .../reference/composer.network.undeploy.md | 4 +- .../reference/composer.network.update.md | 4 +- .../reference/composer.participant.add.md | 4 +- .../reference/composer.transaction.submit.md | 4 +- .../jekylldocs/reference/connectionprofile.md | 2 +- .../jekylldocs/reference/cto_language.md | 12 ++--- .../jekylldocs/reference/glossary.md | 12 ++--- .../jekylldocs/reference/index.md | 4 +- .../jekylldocs/reference/js_scripts.md | 4 +- .../jekylldocs/support/changelog.md | 6 +-- .../jekylldocs/support/index.md | 2 +- .../tutorials/getting-started-cmd-line.md | 20 ++++----- .../tutorials/getting-started-playground.md | 44 +++++++++---------- 56 files changed, 184 insertions(+), 184 deletions(-) diff --git a/packages/composer-website/jekylldocs/_config.yml b/packages/composer-website/jekylldocs/_config.yml index 718436d9a2..64ac3304c7 100644 --- a/packages/composer-website/jekylldocs/_config.yml +++ b/packages/composer-website/jekylldocs/_config.yml @@ -1,4 +1,4 @@ -title: Fabric Composer +title: Hyperledger Composer description: Create business networks and application for Hyperledger email: diff --git a/packages/composer-website/jekylldocs/_data/conrefs.yml b/packages/composer-website/jekylldocs/_data/conrefs.yml index ab32b4def3..51fa4e46a3 100644 --- a/packages/composer-website/jekylldocs/_data/conrefs.yml +++ b/packages/composer-website/jekylldocs/_data/conrefs.yml @@ -3,7 +3,7 @@ composer_short: Composer composer_full: - Fabric Composer + Hyperledger Composer hyperledger_fabric_full: Hyperledger Fabric diff --git a/packages/composer-website/jekylldocs/_includes/head.html b/packages/composer-website/jekylldocs/_includes/head.html index b9776c9868..6c3b5582ec 100644 --- a/packages/composer-website/jekylldocs/_includes/head.html +++ b/packages/composer-website/jekylldocs/_includes/head.html @@ -1,9 +1,9 @@ {% if page.title %} - {{page.title}} | Fabric Composer + {{page.title}} | Hyperledger Composer {% else %} - Fabric Composer - Create Hyperledger business networks and applications + Hyperledger Composer - Create Hyperledger business networks and applications {% endif %} diff --git a/packages/composer-website/jekylldocs/_includes/header.html b/packages/composer-website/jekylldocs/_includes/header.html index 241ae51ef1..c4755aab9d 100644 --- a/packages/composer-website/jekylldocs/_includes/header.html +++ b/packages/composer-website/jekylldocs/_includes/header.html @@ -7,7 +7,7 @@
-

Fabric Composer

+

Hyperledger Composer

-

We're building a community to help people use and contribute to Fabric Composer: either join our team discussion on Rocket.chat, or ask us a question on Stackoverflow. We'd also love to hear your thoughts or feedback on what we're doing!

+

We're building a community to help people use and contribute to Hyperledger Composer: either join our team discussion on Rocket.chat, or ask us a question on Stackoverflow. We'd also love to hear your thoughts or feedback on what we're doing!


And that's not all: if you're a developer, come join us on GitHub. Browse our code, or send us a pull request (and we'll love you forever).

@@ -59,7 +59,7 @@

GitHub

-

Oh hey, you're on the Community page! Hopefully that means you've given Fabric Composer a try: what did you think?

+

Oh hey, you're on the Community page! Hopefully that means you've given Hyperledger Composer a try: what did you think?

You can help us out by completing this 1-question survey (score us from 0 to 10) - we really appreciate your feedback!

diff --git a/packages/composer-website/jekylldocs/applications/genapp.md b/packages/composer-website/jekylldocs/applications/genapp.md index 7a113e8cb9..b8c5a2706d 100644 --- a/packages/composer-website/jekylldocs/applications/genapp.md +++ b/packages/composer-website/jekylldocs/applications/genapp.md @@ -10,7 +10,7 @@ excerpt: How to generate a starter application --- -We're going to assume that you've been through the Getting Started section and would like to now start to look at writing your own application to use Fabric Composer. +We're going to assume that you've been through the Getting Started section and would like to now start to look at writing your own application to use {{site.data.conrefs.composer_full}}. To help getting started with this, there's a [Yeoman](http://yeoman.io/) generator that creates a suitable directory structure and helps bring in the required model and network modules. @@ -49,7 +49,7 @@ yo fabric-composer ``` ``` -Welcome to the Fabric Composer Skeleton Application Generator +Welcome to the Hyperledger Composer Skeleton Application Generator ? Please select the type of Application: (Use arrow keys) ❯ CLI Application Angular2 Application @@ -90,7 +90,7 @@ configuring: composer-sample-app #### What does this do? Firstly it creates a standard npm module with the usual attributes of name, author, description. -Secondly it asks a set of Fabric Composer questions to help create the sample structure. +Secondly it asks a set of {{site.data.conrefs.composer_full}} questions to help create the sample structure. - NPM Module name: What is the name of the business network you want to connect to - and is this the same as the modules NPM registry name - Connection Profile: This is the connection profile used to locate ip/ports etc of the running fabric @@ -122,7 +122,7 @@ Welcome to the Angular2 skeleton app generator ? Do you want to connect to a running Business Network? Yes ? What is the name of the application you wish to generate?: angular-app -? Description of the application: Skeleton Fabric Composer Angular2 project +? Description of the application: Skeleton Hyperledger Composer Angular2 project ? Author name: Sophie Black ? Author email: sophie@ampretia.com ? What is the Business Network Identifier?: org.acme.biznet @@ -144,7 +144,7 @@ Welcome to the Angular2 skeleton app generator ? Do you want to connect to a running Business Network? No ? What is the name of the application you wish to generate?: angular-app -? Description of the application: Skeleton Fabric Composer Angular2 project +? Description of the application: Skeleton Hyperledger Composer Angular2 project ? Author name: Sophie Black ? Author email: sophie@ampretia.com ? What is the name of the business network archive file? (Path from the current working direc diff --git a/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md b/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md index 9b98083397..b20c6bab32 100644 --- a/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md +++ b/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md @@ -1,9 +1,9 @@ --- layout: default -title: Getting Started with a Fabric Composer node.js application +title: Getting Started with a Hyperledger Composer node.js application category: start sidebar: sidebars/applications.md -excerpt: Getting Started with a Fabric Composer node.js application +excerpt: Getting Started with a Hyperledger Composer node.js application --- # Writing a node.js Application @@ -15,10 +15,10 @@ The [`landregistry.js`](https://github.com/fabric-composer/sample-applications/b This has been implemented using a javascript class; however you are free to structure your code as you wish. The framework's API is agnostic to this. The application is also setup as a command line driven application using yargs (see the files in the cmd directory). -We'll look at section of functionality in turn after first looking at the modules that are required and how to connect to a Fabric Composer hosted application on the Hyperledger Fabric. +We'll look at section of functionality in turn after first looking at the modules that are required and how to connect to a {{site.data.conrefs.composer_full}} hosted application on the Hyperledger Fabric. ## Promises -It's worth highlighting that the style of the API is to use promises. Typically Fabric Composer APIs will return a promise that is resolved when the operation has been successfully completed or with the result of the operation if applicable. +It's worth highlighting that the style of the API is to use promises. Typically {{site.data.conrefs.composer_full}} APIs will return a promise that is resolved when the operation has been successfully completed or with the result of the operation if applicable. If you're not familiar with Promise based development it's worth reviewing some of the tutorials online to get an idea. For example [https://scotch.io/tutorials/understanding-javascript-promises-pt-i-background-basics] @@ -27,7 +27,7 @@ If you're not familiar with Promise based development it's worth reviewing some ```javascript const BusinessNetworkConnection = require('composer-client').BusinessNetworkConnection; ``` -For a client application this is only Fabric Composer require needed. In this getting started application we also use the `cli-table` and `winston` and `config` modules for support processing. We use these to get information from the command line options, formatting of output and logging. +For a client application this is only {{site.data.conrefs.composer_full}} require needed. In this getting started application we also use the `cli-table` and `winston` and `config` modules for support processing. We use these to get information from the command line options, formatting of output and logging. ```javascript const winston = require('winston'); @@ -40,7 +40,7 @@ const LOG = winston.loggers.get('application'); ``` -## Connecting to the Fabric Composer Runtime +## Connecting to the {{site.data.conrefs.composer_full}} Runtime We've split the code to connect into two parts, part in the constructor of the object and part in an initialization method. This is an implementation decision made for this example - you are free to structure this in the way that best suits your application. What's important is the API calls and the data. The key thing here is that we need to create a new BusinessNetworkConnection object; and get from application configuration, the connection profile and the business network identifier needed. @@ -51,7 +51,7 @@ this.CONNECTION_PROFILE_NAME = config.get('connectionProfile'); this.businessNetworkIdentifier = config.get('businessNetworkIdentifier'); ``` -The first Fabric Composer API call that we are going to make here, is the connect() API, to establish the connection to the Fabric Composer runtime on the Hyperledger Fabric. +The first {{site.data.conrefs.composer_full}} API call that we are going to make here, is the connect() API, to establish the connection to the {{site.data.conrefs.composer_full}} runtime on the Hyperledger Fabric. This API returns the businessNetworkDefinition if successful - which we hold onto. The API takes, the connection profile name, business network identifier and participant details. ```javascript @@ -64,7 +64,7 @@ this.bizNetworkConnection.connect(this.CONNECTION_PROFILE_NAME, this.businessNet For a client application this is all the essential setup that is required, from this point on it's up to what the application wants to do as to what APIs are called. ##Adding assets to a regsitry -The Fabric Composer runtime will create a default registry to store assets in. So in this example, a LandTitle registry will have been created. What we want to do here is get access to that registry and then add some assets. This `getAssetRegistry()` takes the fully qualified asset name as defined in the CTO model file (That's namespace plus asset name). It returns a promise that is resolved with the asset registry, which we hold onto. +The {{site.data.conrefs.composer_full}} runtime will create a default registry to store assets in. So in this example, a LandTitle registry will have been created. What we want to do here is get access to that registry and then add some assets. This `getAssetRegistry()` takes the fully qualified asset name as defined in the CTO model file (That's namespace plus asset name). It returns a promise that is resolved with the asset registry, which we hold onto. ```javascript this.bizNetworkConnection.getAssetRegistry('net.biz.digitalPropertyNetwork.LandTitle') @@ -135,7 +135,7 @@ this.bizNetworkConnection.getAssetRegistry('net.biz.digitalPropertyNetwork.LandT return(table); }) ``` -Most of this isn't Fabric Composer API code - but it shows how to access the details of the objects that have been returned. At this point it's worth just looking again at the model. +Most of this isn't {{site.data.conrefs.composer_full}} API code - but it shows how to access the details of the objects that have been returned. At this point it's worth just looking again at the model. ``` asset LandTitle identified by titleId { diff --git a/packages/composer-website/jekylldocs/applications/index.md b/packages/composer-website/jekylldocs/applications/index.md index fc1b57c86b..ba2470214b 100644 --- a/packages/composer-website/jekylldocs/applications/index.md +++ b/packages/composer-website/jekylldocs/applications/index.md @@ -1,8 +1,8 @@ --- layout: default -title: Fabric Composer Quickstart +title: Hyperledger Composer Quickstart category: start -excerpt: Getting Started with Fabric Composer +excerpt: Getting Started with Hyperledger Composer --- ## Getting Started - Overview @@ -12,8 +12,8 @@ excerpt: Getting Started with Fabric Composer --- ->This section provides a set of guides that will help you explore the functionality of Fabric Composer in a hands-on fashion. -Before you pick a guide, you should make sure you've followed the essential Fabric Composer setup steps in Quickstart: +>This section provides a set of guides that will help you explore the functionality of {{site.data.conrefs.composer_full}} in a hands-on fashion. +Before you pick a guide, you should make sure you've followed the essential {{site.data.conrefs.composer_full}} setup steps in Quickstart: [Developer Quickstart](./quickstart.md) diff --git a/packages/composer-website/jekylldocs/applications/rest-api-server.md b/packages/composer-website/jekylldocs/applications/rest-api-server.md index 6d588a0d25..c7ee9026a6 100644 --- a/packages/composer-website/jekylldocs/applications/rest-api-server.md +++ b/packages/composer-website/jekylldocs/applications/rest-api-server.md @@ -60,7 +60,7 @@ You will then be asked to enter a few simple details about your business network ? Enter your secret: DJY27pEnl16d WARNING: No configurations found in configuration directory:/Users/samsmith/Projects/BlockChain/Composer/fabric-composer/packages/composer-rest-server/config WARNING: To disable this warning set SUPPRESS_NO_CONFIG_WARNING in the environment. -Loopback Connector for Fabric Composer +Loopback Connector for Hyperledger Composer Models Loaded Now Browse your REST API at http://0.0.0.0:3000/explorer ``` @@ -70,7 +70,7 @@ Browse your REST API at http://0.0.0.0:3000/explorer Alternatively you can run the server specifying all the parameters on the command line ```bash $ composer-rest-server -c car-sample -b org.acme.biznet -i WebAppAdmin -p DJY27pEnl16d -Loopback Connector for Fabric Composer +Loopback Connector for Hyperledger Composer Models Loaded Now Browse your REST API at http://0.0.0.0:3000/explorer ``` diff --git a/packages/composer-website/jekylldocs/business-network/bnd-define.md b/packages/composer-website/jekylldocs/business-network/bnd-define.md index add7d43a1c..8b04b2ad3f 100644 --- a/packages/composer-website/jekylldocs/business-network/bnd-define.md +++ b/packages/composer-website/jekylldocs/business-network/bnd-define.md @@ -10,7 +10,7 @@ excerpt: How to create a business network definition --- -A business network definition is composed of three major items: +A business network definition is composed of three major items: * basic metadata for the business network definition (name, version and description) * a set of domain models that define the structure of the participants, assets and transactions within the network @@ -19,24 +19,24 @@ A business network definition is composed of three major items: ## Generating Skeleton Business Network ### Installing Yeoman Generator -Instructions on installing `yo` and Fabric Composer's Yeoman generator are found [here](../applications/genapp.md) +Instructions on installing `yo` and {{site.data.conrefs.composer_full}}'s Yeoman generator are found [here](../applications/genapp.md) ### Generation 1. `yo fabric-composer` ``` -Welcome to the Fabric Composer Skeleton Application Generator? -Please select the type of Application: - CLI Application - Angular2 Application -❯ Skeleton Business Network +Welcome to the Hyperledger Composer Skeleton Application Generator? +Please select the type of Application: + CLI Application + Angular2 Application +❯ Skeleton Business Network ``` And select `Skeleton Business Netork` 2. Answer all of the questions ``` -Welcome to the Fabric Composer Skeleton Application Generator +Welcome to the Hyperledger Composer Skeleton Application Generator ? Please select the type of Application: Skeleton Business Network You can run this generator using: 'yo fabric-composer:businessnetwork' Welcome to the business network skeleton generator @@ -54,7 +54,7 @@ Welcome to the business network skeleton generator create models/org.acme.biznet.cto ``` -This generates a skeleton business network with an `asset`, `participant` and `transaction` defined, as well as a `mocha` unit test. +This generates a skeleton business network with an `asset`, `participant` and `transaction` defined, as well as a `mocha` unit test. Also included, is a 'best practices' eslint config file diff --git a/packages/composer-website/jekylldocs/business-network/businessnetwork.md b/packages/composer-website/jekylldocs/business-network/businessnetwork.md index 52d5b12734..ff1c6a3fb7 100644 --- a/packages/composer-website/jekylldocs/business-network/businessnetwork.md +++ b/packages/composer-website/jekylldocs/business-network/businessnetwork.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Business Network +title: Hyperledger Composer - Business Network category: concepts sidebar: sidebars/businessnetworks.md excerpt: Business Network @@ -10,7 +10,7 @@ excerpt: Business Network --- -A `Business Network` describes the structures and processes that exist in the exchange of assets between participants in economic networks. Fabric Composer helps you to easily develop applications for business networks, to digitize these networks - making them more efficient. +A `Business Network` describes the structures and processes that exist in the exchange of assets between participants in economic networks. {{site.data.conrefs.composer_full}} helps you to easily develop applications for business networks, to digitize these networks - making them more efficient. There are many elements in a business network; the most fundamental of which are participants, assets, registries and transactions. We're going to start by explaining these so that you get a feeling for this most important concepts. We'll then reinforce these slightly abstract concepts with a concrete example involving a digital property network. @@ -38,7 +38,7 @@ Here are the key elements of this property network. * Transactions. There are many transactions going on in this property network. Sellers sell property and buyers buy them. Conveyancers create and exchange legal contracts with other conveyancers on behalf of buyers and sellers and their respective property sales. The Land Registry records updates to property ownership, and estate agents (realtors) indicate that properties are for sale in a market and remove them from that market once they have been sold. -Fabric Composer makes it easy to create these elements in a business network, and the applications which capture interactions between different participants. +{{site.data.conrefs.composer_full}} makes it easy to create these elements in a business network, and the applications which capture interactions between different participants. ## Related Concepts diff --git a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md index 6350a18e67..ea09aee244 100644 --- a/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/business-network/businessnetworkdefinition.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Business Network Definition +title: Hyperledger Composer - Business Network Definition category: concepts sidebar: sidebars/businessnetworks.md excerpt: Overview of the Business Network Definition @@ -10,7 +10,7 @@ excerpt: Overview of the Business Network Definition --- -Business Network Definitions are a key concept of the Fabric Composer programming model. They are represented by the `BusinessNetworkDefinition` class, defined in the `composer-common` module and exported by both `composer-admin` and `composer-client`. +Business Network Definitions are a key concept of the {{site.data.conrefs.composer_full}} programming model. They are represented by the `BusinessNetworkDefinition` class, defined in the `composer-common` module and exported by both `composer-admin` and `composer-client`. Business Network Definitions are composed of: diff --git a/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md b/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md index b0e3a9c04f..3eeb5dc1de 100644 --- a/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md +++ b/packages/composer-website/jekylldocs/business-network/deploybusinessnetwork.md @@ -34,7 +34,7 @@ A business network is deployed using the `composer network deploy` command. 2. Start [Hyperledger Fabric Peer and Membership Service](runtime-start.md) -3. [Create a Connection Profile](../installing/createconnectionprofile.html) or do *not* use `-p` and allow Fabric Composer to create a `Default Connection Profile` for you. +3. [Create a Connection Profile](../installing/createconnectionprofile.html) or do *not* use `-p` and allow {{site.data.conrefs.composer_full}} to create a `Default Connection Profile` for you. 4. Enter the command on a single line. For example: diff --git a/packages/composer-website/jekylldocs/business-network/getting-started-coding-bnd.md b/packages/composer-website/jekylldocs/business-network/getting-started-coding-bnd.md index b64b1abe7c..ea7555690d 100644 --- a/packages/composer-website/jekylldocs/business-network/getting-started-coding-bnd.md +++ b/packages/composer-website/jekylldocs/business-network/getting-started-coding-bnd.md @@ -14,7 +14,7 @@ This tutorial will take you through how to code and deploy a Business Network De This is after the important step of modeling the actual business network and the entities within it. For this tutorial we are going to continue to use the Digital Property Network but from the position of having only the model file and the transction function file. # Style of creation -The final form of the Business Network Archive is mandatory for Fabric Composer. This file is created using the `composer archive create` command; however how the files that are taken as input to that command are created and managed is not mandatory. In all the documents and websites we are showing a selection of approaches we consider to be good practice. +The final form of the Business Network Archive is mandatory for {{site.data.conrefs.composer_full}}. This file is created using the `composer archive create` command; however how the files that are taken as input to that command are created and managed is not mandatory. In all the documents and websites we are showing a selection of approaches we consider to be good practice. For this tutorial, a single NPM module will be created for both the model and transaction functions. An archive will be created from this locally and deployed. In production this NPM module would be published to a NPM repository, in development/test context this is not required. @@ -24,7 +24,7 @@ Also the command line set of tools will be used. #Creating the npm Module. ## Basic Infrastrure -We will need to have the command line Fabric Composer tools installed. If you've not done this yet +We will need to have the command line {{site.data.conrefs.composer_full}} tools installed. If you've not done this yet ```bash $ npm install -g composer-cli @@ -92,7 +92,7 @@ $ touch models/DigitalLandTitle.cto Load that file up in any editor and then add your own model, or copy in the code below that is the DigitalLandTitle Getting Started Example ``` -/** A 'Getting Started Tutorial' to work with Fabric Composer +/** A 'Getting Started Tutorial' to work with Hyperledger Composer */ namespace net.biz.digitalPropertyNetwork diff --git a/packages/composer-website/jekylldocs/business-network/model-define.md b/packages/composer-website/jekylldocs/business-network/model-define.md index 20e3809a2a..ff4c57de74 100644 --- a/packages/composer-website/jekylldocs/business-network/model-define.md +++ b/packages/composer-website/jekylldocs/business-network/model-define.md @@ -10,10 +10,10 @@ excerpt: How to create a business domain model --- -You use the CTO language to model a business domain. The language allows you to quickly and unambiguously declare to Fabric Composer the structure of your transactions, assets and participants. These can be simple, or can become very sophisticated as the CTO language allows you to import types from external namespaces, subclass types, declare relationships to types etc. +You use the CTO language to model a business domain. The language allows you to quickly and unambiguously declare to {{site.data.conrefs.composer_full}} the structure of your transactions, assets and participants. These can be simple, or can become very sophisticated as the CTO language allows you to import types from external namespaces, subclass types, declare relationships to types etc. The elements of the CTO language are described in detail in the reference section of the documentation. -Fabric Composer uses your domain models for a wide variety of tasks, from ensuring that submitted transactions are valid instances, to serializing and validating your assets to/from JSON, to generating Typescript code for your user interface applications. +{{site.data.conrefs.composer_full}} uses your domain models for a wide variety of tasks, from ensuring that submitted transactions are valid instances, to serializing and validating your assets to/from JSON, to generating Typescript code for your user interface applications. -A Fabric Composer domain model is one or more CTO files. Each CTO file has a single namespace and contains type definitions. A set of CTO files may be managed in a project along with a `package.json` file, allowing the set of CTO files to be publish and versioned using `npm`. +A {{site.data.conrefs.composer_full}} domain model is one or more CTO files. Each CTO file has a single namespace and contains type definitions. A set of CTO files may be managed in a project along with a `package.json` file, allowing the set of CTO files to be publish and versioned using `npm`. diff --git a/packages/composer-website/jekylldocs/index.html b/packages/composer-website/jekylldocs/index.html index 92f0cd301f..e79ae5dfaa 100644 --- a/packages/composer-website/jekylldocs/index.html +++ b/packages/composer-website/jekylldocs/index.html @@ -1,6 +1,6 @@ --- layout: indexbase -title: Fabric Composer - Create business networks and blockchain applications quickly for Hyperledger +title: {{site.data.conrefs.composer_full}} - Create business networks and blockchain applications quickly for Hyperledger ---
diff --git a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md index c24ebdb2c5..89a26d2a44 100644 --- a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md +++ b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md @@ -10,7 +10,7 @@ excerpt: How to create a new Connection Profile --- -A Connection Profile is used by Fabric Composer to connect to a running fabric. More information about Connection Profiles can be found [here](../reference/connectionprofile.html) +A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect to a running fabric. More information about Connection Profiles can be found [here](../reference/connectionprofile.html) ## Procedure diff --git a/packages/composer-website/jekylldocs/installing/installingindex.md b/packages/composer-website/jekylldocs/installing/installingindex.md index 22888e6787..c04bf02564 100644 --- a/packages/composer-website/jekylldocs/installing/installingindex.md +++ b/packages/composer-website/jekylldocs/installing/installingindex.md @@ -1,8 +1,8 @@ --- layout: default -title: Installing Fabric Composer +title: Installing Hyperledger Composer sidebar: sidebars/installing.md -excerpt: Installing Fabric Composer +excerpt: Installing Hyperledger Composer --- # Installing {{site.data.conrefs.composer_full}} diff --git a/packages/composer-website/jekylldocs/installing/quickstart.md b/packages/composer-website/jekylldocs/installing/quickstart.md index c71cebfcf5..f284b8bf2b 100644 --- a/packages/composer-website/jekylldocs/installing/quickstart.md +++ b/packages/composer-website/jekylldocs/installing/quickstart.md @@ -1,13 +1,13 @@ --- layout: default -title: Fabric Composer Quickstart +title: Hyperledger Composer Quickstart category: start sidebar: sidebars/installing.md excerpt: Quickstart --- -# Fabric Composer Quickstart +# {{site.data.conrefs.composer_full}} Quickstart --- 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 08eca4ee58..b609ad9c39 100644 --- a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md +++ b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md @@ -12,7 +12,7 @@ excerpt: Generating a REST API This guide will show how to generate a REST API for the Digital Property business network. This api will be dynamically generated by using [LoopBack](https://loopback.io/doc/index.html) from the specified Business Network Model. What is generated is not a generic API, but is specifically configured to let you interact with the assets you have specified. -To get started with using this to create a REST interface to a Business Network, follow the steps below. If you've not followed the [Getting Started](../installing/quickstart.md) guide yet, it's worth following that first so you have Fabric Composer up and running on Hyperledger. +To get started with using this to create a REST interface to a Business Network, follow the steps below. If you've not followed the [Getting Started](../installing/quickstart.md) guide yet, it's worth following that first so you have {{site.data.conrefs.composer_full}} up and running on Hyperledger. # Check that the Digital Land Title Network is up and running @@ -47,7 +47,7 @@ We can see the two sample land titles listed. ## Install the general purpose Composer REST Server -We need to install the Fabric Composer REST server; this is an npm module named `composer-rest-server``. +We need to install the {{site.data.conrefs.composer_full}} REST server; this is an npm module named `composer-rest-server``. >You might need to issue this command using sudo. @@ -56,7 +56,7 @@ npm install -g composer-rest-server ``` ## Running the REST server -You should now be able to run the Fabric Composer REST server. +You should now be able to run the {{site.data.conrefs.composer_full}} REST server. ```bash composer-rest-server @@ -169,4 +169,4 @@ info: [Composer-GettingStarted] Command completed successfully. ``` #Summary -Using the Loopback framework on top of the Fabric Composer runtime has allowed us to generate a business domain specific REST api based on the deployed business network model! +Using the Loopback framework on top of the {{site.data.conrefs.composer_full}} runtime has allowed us to generate a business domain specific REST api based on the deployed business network model! diff --git a/packages/composer-website/jekylldocs/introduction/businessnetwork.md b/packages/composer-website/jekylldocs/introduction/businessnetwork.md index 7ba3a220d9..1be4ed9803 100644 --- a/packages/composer-website/jekylldocs/introduction/businessnetwork.md +++ b/packages/composer-website/jekylldocs/introduction/businessnetwork.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Business Network +title: Hyperledger Composer - Business Network category: concepts sidebar: sidebars/introduction.md excerpt: Business Network @@ -10,7 +10,7 @@ excerpt: Business Network --- -A `Business Network` describes the structures and processes that exist in the exchange of assets between participants in economic networks. Fabric Composer helps you to easily develop applications for business networks, to digitize these networks - making them more efficient. +A `Business Network` describes the structures and processes that exist in the exchange of assets between participants in economic networks. {{site.data.conrefs.composer_full}} helps you to easily develop applications for business networks, to digitize these networks - making them more efficient. There are many elements in a business network; the most fundamental of which are participants, assets, registries and transactions. We're going to start by explaining these so that you get a feeling for this most important concepts. We'll then reinforce these slightly abstract concepts with a concrete example involving a digital property network. @@ -38,7 +38,7 @@ Here are the key elements of this property network. * Transactions. There are many transactions going on in this property network. Sellers sell property and buyers buy them. Conveyancers create and exchange legal contracts with other conveyancers on behalf of buyers and sellers and their respective property sales. The Land Registry records updates to property ownership, and estate agents (realtors) indicate that properties are for sale in a market and remove them from that market once they have been sold. -Fabric Composer makes it easy to create these elements in a business network, and the applications which capture interactions between different participants. +{{site.data.conrefs.composer_full}} makes it easy to create these elements in a business network, and the applications which capture interactions between different participants. ## Related Concepts diff --git a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md index fa3e15c340..24fbcb58f5 100644 --- a/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md +++ b/packages/composer-website/jekylldocs/introduction/businessnetworkdefinition.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Business Network Definition +title: Hyperledger Composer - Business Network Definition category: concepts sidebar: sidebars/introduction.md excerpt: Overview of the Business Network Definition @@ -10,7 +10,7 @@ excerpt: Overview of the Business Network Definition --- -Business Network Definitions are a key concept of the Fabric Composer programming model. They are represented by the `BusinessNetworkDefinition` class, defined in the `composer-common` module and exported by both `composer-admin` and `composer-client`. +Business Network Definitions are a key concept of the {{site.data.conrefs.composer_full}} programming model. They are represented by the `BusinessNetworkDefinition` class, defined in the `composer-common` module and exported by both `composer-admin` and `composer-client`. Business Network Definitions are composed of: diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index 36af099d0e..da579320a9 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -1,36 +1,36 @@ --- layout: default -title: Fabric Composer - Overview +title: Hyperledger Composer - Overview category: overview sidebar: sidebars/introduction.md -excerpt: Fabric Composer overview +excerpt: Hyperledger Composer overview --- --- -# Welcome to Fabric Composer +# Welcome to {{site.data.conrefs.composer_full}} --- -You can use Fabric Composer to rapidly develop and deploy a blockchain solution; modeling your business network and integrating existing systems and data. +You can use {{site.data.conrefs.composer_full}} to rapidly develop and deploy a blockchain solution; modeling your business network and integrating existing systems and data. -Fabric Composer requires and exploits the existing [Hyperledger Fabric blockchain](https://hyperledger.org) technology, using the blockchain consensus protocol to ensure that transactions are validated by business network participants. +{{site.data.conrefs.composer_full}} requires and exploits the existing [Hyperledger Fabric blockchain](https://hyperledger.org) technology, using the blockchain consensus protocol to ensure that transactions are validated by business network participants. Applications can consume the data from business networks, providing end users with simple and controlled access points. Existing data can also be integrated you modeled network, allowing complex systems and solutions to contribute data and . -You can use Fabric Composer to quickly model your business network, containing your existing assets and the transactions related to them, whether your assets are tangible or intangible goods, services, or property. As part of your business network model, you define the transactions which are used to interact with assets. Business networks also include the participants who interact with them, each of which can be associated with a unique identity across multiple business networks. +You can use {{site.data.conrefs.composer_full}} to quickly model your business network, containing your existing assets and the transactions related to them, whether your assets are tangible or intangible goods, services, or property. As part of your business network model, you define the transactions which are used to interact with assets. Business networks also include the participants who interact with them, each of which can be associated with a unique identity across multiple business networks. --- -## Key Fabric Composer concepts diagram +## Key {{site.data.conrefs.composer_full}} concepts diagram --- -![Diagram of Fabric Composer](/assets/img/Composer-Diagram.svg) +![Diagram of {{site.data.conrefs.composer_full}}](/assets/img/Composer-Diagram.svg) --- -## How does Fabric Composer work in practise? +## How does {{site.data.conrefs.composer_full}} work in practise? <<<<<<< HEAD For an example of a business network in action; a realtor can quickly model their business network; including houses and listings assets, buyers and homeowners as participants, and buying or selling houses, and creating and closing listings as transactions. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor can then create an application to present buyers and sellers with a simple user interface for viewing open listings and making offers. This business network could also be integrated with existing inventory system, adding new houses as assets and removing sold properties. Relevant other parties can be registered as participants, for example a land registry might interact with a buyer to transfer ownership of the land. @@ -46,4 +46,4 @@ For an example of a business network in action; a realtor may have a business ne --- -To get started with Fabric Composer right away, try the [Fabric Composer tutorials](../tutorials/tutorialindex.html), to learn more about Fabric Composer read [understanding Fabric Composer](../introduction/key-concepts.html), to get installed and trying the full product immediately go to [installing Fabric Composer](../installing/prerequisites.html). +To get started with {{site.data.conrefs.composer_full}} right away, try the [{{site.data.conrefs.composer_full}} tutorials](../tutorials/tutorialindex.html), to learn more about {{site.data.conrefs.composer_full}} read [understanding {{site.data.conrefs.composer_full}}](../introduction/key-concepts.html), to get installed and trying the full product immediately go to [installing {{site.data.conrefs.composer_full}}](../installing/prerequisites.html). diff --git a/packages/composer-website/jekylldocs/introduction/key-concepts.md b/packages/composer-website/jekylldocs/introduction/key-concepts.md index 7d0f8daa11..1bd304fcc2 100644 --- a/packages/composer-website/jekylldocs/introduction/key-concepts.md +++ b/packages/composer-website/jekylldocs/introduction/key-concepts.md @@ -1,6 +1,6 @@ --- layout: default -title: Key Concepts in Fabric Composer +title: Key Concepts in Hyperledger Composer sidebar: sidebars/introduction.md excerpt: --- @@ -9,7 +9,7 @@ excerpt: --- -Fabric Composer 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**. +{{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/participantsandidentities.md b/packages/composer-website/jekylldocs/introduction/participantsandidentities.md index d1c8ea3ac8..8dc4f48423 100644 --- a/packages/composer-website/jekylldocs/introduction/participantsandidentities.md +++ b/packages/composer-website/jekylldocs/introduction/participantsandidentities.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Participants and Identities +title: Hyperledger Composer - Participants and Identities category: concepts sidebar: sidebars/introduction.md excerpt: Business Network diff --git a/packages/composer-website/jekylldocs/managing/identity-issue.md b/packages/composer-website/jekylldocs/managing/identity-issue.md index db2d392871..73bf793816 100644 --- a/packages/composer-website/jekylldocs/managing/identity-issue.md +++ b/packages/composer-website/jekylldocs/managing/identity-issue.md @@ -14,7 +14,7 @@ An identity can be issued to a participant using either the API or the command l 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. -Fabric Composer issues identities as Hyperledger Fabric enrollment +{{site.data.conrefs.composer_full}} issues identities as Hyperledger Fabric enrollment certificates (ECerts). An enrollment secret is generated that should be given to the participant, who can use the enrollment secret to download their enrollment certificate. diff --git a/packages/composer-website/jekylldocs/managing/identity-revoke.md b/packages/composer-website/jekylldocs/managing/identity-revoke.md index 3f2128903d..2db7303f4d 100644 --- a/packages/composer-website/jekylldocs/managing/identity-revoke.md +++ b/packages/composer-website/jekylldocs/managing/identity-revoke.md @@ -14,7 +14,7 @@ An identity can be revoked from a participant using either the API or the comman 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. -Fabric Composer issues identities as Hyperledger Fabric enrollment +{{site.data.conrefs.composer_full}} issues identities as Hyperledger Fabric enrollment certificates (ECerts). When an identity is revoked, the enrollment certificate is still valid, but it cannot be used to interact with the business network. This is due to a current limitation in Hyperledger Fabric that does not allow the IBM diff --git a/packages/composer-website/jekylldocs/managing/participantsandidentities.md b/packages/composer-website/jekylldocs/managing/participantsandidentities.md index 84945ed08c..e7cb8175f2 100644 --- a/packages/composer-website/jekylldocs/managing/participantsandidentities.md +++ b/packages/composer-website/jekylldocs/managing/participantsandidentities.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Participants and Identities +title: Hyperledger Composer - Participants and Identities category: concepts sidebar: sidebars/managing.md excerpt: Business Network diff --git a/packages/composer-website/jekylldocs/overview/overview.md b/packages/composer-website/jekylldocs/overview/overview.md index bc1f85d3bf..9412db511a 100644 --- a/packages/composer-website/jekylldocs/overview/overview.md +++ b/packages/composer-website/jekylldocs/overview/overview.md @@ -1,16 +1,16 @@ --- layout: default -title: Fabric Composer - Overview +title: Hyperledger Composer - Overview category: overview sidebar: sidebars/introduction.md -excerpt: Fabric Composer overview +excerpt: Hyperledger Composer overview --- # Overview --- -Fabric Composer is a set of APIs, a modeling language and +{{site.data.conrefs.composer_full}} is a set of APIs, a modeling language and a programming model to quickly define and deploy business networks and applications that allow **participants** to send **transactions** that exchange **assets**. @@ -31,18 +31,18 @@ are validated by concerned organizations in the business network. | Analytics and Monitoring integration | Provides integration extension points to send transactions to external analytics data stores | | Starter Applications | Generate starter applications from a Business Network Definition | -## Fabric Composer Programming Model +## {{site.data.conrefs.composer_full}} Programming Model -The Fabric Composer programming model is based on defining and deploying a Business Network +The {{site.data.conrefs.composer_full}} programming model is based on defining and deploying a Business Network Definition, which contains a data model that defines the name and structure of assets, participants and transactions in the business network. The business network also specifies *transaction processor functions* (written in ES5 Javascript) that are automatically run on a Hyperledger Fabric when transactions are submitted by clients. -Fabric Composer defines [Javascript APIs](https://fabric-composer.github.io/jsdoc/index.html)to submit transactions and to create, retrieve, update and delete assets within asset registries. +{{site.data.conrefs.composer_full}} defines [Javascript APIs](https://fabric-composer.github.io/jsdoc/index.html)to submit transactions and to create, retrieve, update and delete assets within asset registries. ### Roles, Responsibilities and Tasks -A typical project using Fabric Composer goes through a lifecycle of: +A typical project using {{site.data.conrefs.composer_full}} goes through a lifecycle of: *Model -> Define Business Network -> Deploy Runtime -> Deploying Business Network -> Test -> Generate Application* @@ -54,9 +54,9 @@ These tasks may all be performed by a single full-stack developer, but are more ## Modeling the Business Domain -Fabric Composer includes a powerful Object-Oriented modeling language, used to specify a domain model; the structure of assets, participants and transactions. The domain model is used across the Framework for code generation, type validation, user interface generation, API generation, amongst other things. +{{site.data.conrefs.composer_full}} includes a powerful Object-Oriented modeling language, used to specify a domain model; the structure of assets, participants and transactions. The domain model is used across the Framework for code generation, type validation, user interface generation, API generation, amongst other things. -### Sample Fabric Composer Domain Model +### Sample {{site.data.conrefs.composer_full}} Domain Model ```javascript namespace net.biz.digitalPropertyNetwork @@ -108,7 +108,7 @@ function onRegisterPropertyForSale(propertyForSale){ ## Rapidly Create Applications -Fabric Composer includes [code generators](../tasks/genapp.md) so that web and mid-tier application developers can quickly generate starter applications that interact with a deployed business network definition. These code generators allow application developers to quickly focus on the integration and visual aspects of their projects, rather than writing boilerplate and configuration. +{{site.data.conrefs.composer_full}} includes [code generators](../tasks/genapp.md) so that web and mid-tier application developers can quickly generate starter applications that interact with a deployed business network definition. These code generators allow application developers to quickly focus on the integration and visual aspects of their projects, rather than writing boilerplate and configuration. High-level administration and client APIs provide easy access to a deployed business network. diff --git a/packages/composer-website/jekylldocs/problems/diagnostics.md b/packages/composer-website/jekylldocs/problems/diagnostics.md index 3d3ebdc745..031b068ed7 100644 --- a/packages/composer-website/jekylldocs/problems/diagnostics.md +++ b/packages/composer-website/jekylldocs/problems/diagnostics.md @@ -14,7 +14,7 @@ If something should ever go wrong with an application, what should you do about Let's look at the Getting Started application, and use that to explain how to get diagnostics out of the Framework. -Key Point: This is a framework - so your application will need to have it's own logging framework. Plus, your application could also have configuration information to control Fabric Composer's own logging. Composer does use the Winston logging module by default - and will use the Config module to look for any configuration information. If none is found, then a set of defaults will be used. +Key Point: This is a framework - so your application will need to have it's own logging framework. Plus, your application could also have configuration information to control {{site.data.conrefs.composer_full}}'s own logging. Composer does use the Winston logging module by default - and will use the Config module to look for any configuration information. If none is found, then a set of defaults will be used. Note that the config module does write out a warning, if there are no configuration files set. Eg. `WARNING: No configurations found in configuration directory`. This can be suppressed with an environment variable if you are happy with the defaults and don't wish to use config in your application. See more information [here](https://github.com/lorenwest/node-config/wiki/Environment-Variables#suppress_no_config_warning). @@ -25,7 +25,7 @@ There are two containers that are relevant to logging; ## Application -Internally, Fabric Composer uses the [Winston](https://github.com/winstonjs/winston) node.js logging package by default, with an initial level of log points and destinations set up. +Internally, {{site.data.conrefs.composer_full}} uses the [Winston](https://github.com/winstonjs/winston) node.js logging package by default, with an initial level of log points and destinations set up. ## Default Configuration @@ -79,7 +79,7 @@ For example } ``` -The first section is specific to the Getting Started application, the second `ComposerConfig` section is for the Fabric Composer. +The first section is specific to the Getting Started application, the second `ComposerConfig` section is for the {{site.data.conrefs.composer_full}}. - `logger` is used to refer the module that does actual logging. default is implying that this is the winston framework - `config` is passed to the logger to control what it does. So this section is specific to the logger in use. diff --git a/packages/composer-website/jekylldocs/reference/MeetTheModules.md b/packages/composer-website/jekylldocs/reference/MeetTheModules.md index 5b0947091d..f436ed793b 100644 --- a/packages/composer-website/jekylldocs/reference/MeetTheModules.md +++ b/packages/composer-website/jekylldocs/reference/MeetTheModules.md @@ -1,16 +1,16 @@ --- layout: default -title: Fabric Composer - Meet the Modules and Git Repos +title: Hyperledger Composer - Meet the Modules and Git Repos category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer module info +excerpt: Hyperledger Composer module info --- # Meet the npm Modules --- -Fabric Composer has 3 main modules for application developers. If you are writing an application this is your entry point. +{{site.data.conrefs.composer_full}} has 3 main modules for application developers. If you are writing an application this is your entry point. 1. `composer-client` diff --git a/packages/composer-website/jekylldocs/reference/acl_language.md b/packages/composer-website/jekylldocs/reference/acl_language.md index 65335d8348..53a3f93165 100644 --- a/packages/composer-website/jekylldocs/reference/acl_language.md +++ b/packages/composer-website/jekylldocs/reference/acl_language.md @@ -1,16 +1,16 @@ --- layout: default -title: Fabric Composer - Access Contol Language +title: Hyperledger Composer - Access Contol Language category: reference sidebar: sidebars/reference.md -excerpt: Guide to the Fabric Composer access control language +excerpt: Guide to the Hyperledger Composer access control language --- -# Fabric Composer Access Control Language +# {{site.data.conrefs.composer_full}} Access Control Language --- -Fabric Composer includes an access control language (ACL) that provides declarative access control over the elements of the domain model. By defining ACL rules you can determine which users/roles are permitted to create, read, update or delete elements in a business network's domain model. +{{site.data.conrefs.composer_full}} includes an access control language (ACL) that provides declarative access control over the elements of the domain model. By defining ACL rules you can determine which users/roles are permitted to create, read, update or delete elements in a business network's domain model. ### Evaluation of Access Control Rules @@ -34,7 +34,7 @@ rule SimpleRule { } ```` -Conditional ACL rules introduce variable bindings for the participant and the resource being accessed, and a Boolean Javascript expression, which, when true, can either ALLOW or DENY access to the resource by the participant. +Conditional ACL rules introduce variable bindings for the participant and the resource being accessed, and a Boolean Javascript expression, which, when true, can either ALLOW or DENY access to the resource by the participant. For example, the rule below states that any instance of the `org.acme.SampleParticipant` type can perform ALL operations on all instances of `org.acme.SampeAsset` IF the participant is the owner of the asset. diff --git a/packages/composer-website/jekylldocs/reference/commands.md b/packages/composer-website/jekylldocs/reference/commands.md index 8f589abe73..fb202cefc7 100644 --- a/packages/composer-website/jekylldocs/reference/commands.md +++ b/packages/composer-website/jekylldocs/reference/commands.md @@ -1,19 +1,19 @@ --- layout: default -title: Fabric Composer Command Line +title: Hyperledger Composer Command Line category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer Command Line +excerpt: Hyperledger Composer Command Line --- -# Fabric Composer Command Line +# {{site.data.conrefs.composer_full}} Command Line --- -The Fabric Composer command line application, `composer`, can be used to perform multiple +The {{site.data.conrefs.composer_full}} command line application, `composer`, can be used to perform multiple administrative, operational, and development tasks. -The Fabric Composer command line application can be installed using npm: +The {{site.data.conrefs.composer_full}} command line application can be installed using npm: `npm install -g composer-cli` diff --git a/packages/composer-website/jekylldocs/reference/composer.archive.create.md b/packages/composer-website/jekylldocs/reference/composer.archive.create.md index 00ada212ef..900e72d6ab 100644 --- a/packages/composer-website/jekylldocs/reference/composer.archive.create.md +++ b/packages/composer-website/jekylldocs/reference/composer.archive.create.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Archive Create CLI +title: Hyperledger Composer Archive Create CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Archive Create CLI --- -# Fabric Composer Archive Create +# {{site.data.conrefs.composer_full}} Archive Create --- diff --git a/packages/composer-website/jekylldocs/reference/composer.archive.list.md b/packages/composer-website/jekylldocs/reference/composer.archive.list.md index d16f388881..19d3b5b385 100644 --- a/packages/composer-website/jekylldocs/reference/composer.archive.list.md +++ b/packages/composer-website/jekylldocs/reference/composer.archive.list.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Archive List CLI +title: Hyperledger Composer Archive List CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Archive List CLI --- -# Fabric Composer Archive List +# {{site.data.conrefs.composer_full}} Archive List --- diff --git a/packages/composer-website/jekylldocs/reference/composer.generator.create.md b/packages/composer-website/jekylldocs/reference/composer.generator.create.md index dc47805fd7..00cc0d8272 100644 --- a/packages/composer-website/jekylldocs/reference/composer.generator.create.md +++ b/packages/composer-website/jekylldocs/reference/composer.generator.create.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer Generator CLI +title: Hyperledger Composer Generator CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Archive List CLI diff --git a/packages/composer-website/jekylldocs/reference/composer.generator.md b/packages/composer-website/jekylldocs/reference/composer.generator.md index 12191fb400..c31f30a665 100644 --- a/packages/composer-website/jekylldocs/reference/composer.generator.md +++ b/packages/composer-website/jekylldocs/reference/composer.generator.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer Generator CLI +title: Hyperledger Composer Generator CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Archive List CLI diff --git a/packages/composer-website/jekylldocs/reference/composer.generator.tests.md b/packages/composer-website/jekylldocs/reference/composer.generator.tests.md index e62ebea655..220469cb96 100644 --- a/packages/composer-website/jekylldocs/reference/composer.generator.tests.md +++ b/packages/composer-website/jekylldocs/reference/composer.generator.tests.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Generator CLI +title: Hyperledger Composer Generator CLI category: reference sidebar: sidebars/reference.md excerpt: Generator CLI --- -# Fabric Composer Generator +# {{site.data.conrefs.composer_full}} Generator --- diff --git a/packages/composer-website/jekylldocs/reference/composer.identity.issue.md b/packages/composer-website/jekylldocs/reference/composer.identity.issue.md index 32282e7d42..08792add95 100644 --- a/packages/composer-website/jekylldocs/reference/composer.identity.issue.md +++ b/packages/composer-website/jekylldocs/reference/composer.identity.issue.md @@ -1,9 +1,9 @@ --- layout: default -title: Fabric Composer Identity Issue Command +title: Hyperledger Composer Identity Issue Command category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer Identity Issue Command +excerpt: Hyperledger Composer Identity Issue Command --- # Composer Identity Issue diff --git a/packages/composer-website/jekylldocs/reference/composer.identity.revoke.md b/packages/composer-website/jekylldocs/reference/composer.identity.revoke.md index 3e06e8b6ae..6f07676cf6 100644 --- a/packages/composer-website/jekylldocs/reference/composer.identity.revoke.md +++ b/packages/composer-website/jekylldocs/reference/composer.identity.revoke.md @@ -1,9 +1,9 @@ --- layout: default -title: Fabric Composer Identity Revoke Command +title: Hyperledger Composer Identity Revoke Command category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer Identity Revoke Command +excerpt: Hyperledger Composer Identity Revoke Command --- # composer identity revoke diff --git a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md index f946d67e84..157b97fb12 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.deploy.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.deploy.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Network Deploy CLI +title: Hyperledger Composer Network Deploy CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Network Deploy CLI --- -# Fabric Composer Network Deploy +# {{site.data.conrefs.composer_full}} Network Deploy --- diff --git a/packages/composer-website/jekylldocs/reference/composer.network.list.md b/packages/composer-website/jekylldocs/reference/composer.network.list.md index 7e06784d0a..fd761f91b9 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.list.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.list.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Network List CLI +title: Hyperledger Composer Network List CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Network List CLI --- -# Fabric Composer Network List +# {{site.data.conrefs.composer_full}} Network List --- diff --git a/packages/composer-website/jekylldocs/reference/composer.network.ping.md b/packages/composer-website/jekylldocs/reference/composer.network.ping.md index c4da15743c..0d61271503 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.ping.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.ping.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Network Ping CLI +title: Hyperledger Composer Network Ping CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Network Ping CLI --- -# Fabric Composer Network Ping +# {{site.data.conrefs.composer_full}} Network Ping --- diff --git a/packages/composer-website/jekylldocs/reference/composer.network.undeploy.md b/packages/composer-website/jekylldocs/reference/composer.network.undeploy.md index 8b89cb53d8..4e178b1f30 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.undeploy.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.undeploy.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Network Undeploy CLI +title: Hyperledger Composer Network Undeploy CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Network Undeploy CLI --- -# Fabric Composer Network Undeploy +# {{site.data.conrefs.composer_full}} Network Undeploy --- diff --git a/packages/composer-website/jekylldocs/reference/composer.network.update.md b/packages/composer-website/jekylldocs/reference/composer.network.update.md index 7b50d67f83..ab5b761220 100644 --- a/packages/composer-website/jekylldocs/reference/composer.network.update.md +++ b/packages/composer-website/jekylldocs/reference/composer.network.update.md @@ -1,12 +1,12 @@ --- layout: default -title: Fabric Composer Network Update CLI +title: Hyperledger Composer Network Update CLI category: reference sidebar: sidebars/reference.md excerpt: Composer Network Update CLI --- -# Fabric Composer Network Update +# {{site.data.conrefs.composer_full}} Network Update --- diff --git a/packages/composer-website/jekylldocs/reference/composer.participant.add.md b/packages/composer-website/jekylldocs/reference/composer.participant.add.md index a3759981cf..266d383521 100644 --- a/packages/composer-website/jekylldocs/reference/composer.participant.add.md +++ b/packages/composer-website/jekylldocs/reference/composer.participant.add.md @@ -1,9 +1,9 @@ --- layout: default -title: Fabric Composer Participant Add Command +title: Hyperledger Composer Participant Add Command category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer Participant Add Command +excerpt: Hyperledger Composer Participant Add Command --- # Composer participant add diff --git a/packages/composer-website/jekylldocs/reference/composer.transaction.submit.md b/packages/composer-website/jekylldocs/reference/composer.transaction.submit.md index 98969d7431..61963d2072 100644 --- a/packages/composer-website/jekylldocs/reference/composer.transaction.submit.md +++ b/packages/composer-website/jekylldocs/reference/composer.transaction.submit.md @@ -1,9 +1,9 @@ --- layout: default -title: Fabric Composer Transaction Submit Command +title: Hyperledger Composer Transaction Submit Command category: reference sidebar: sidebars/reference.md -excerpt: Fabric Composer Transaction Submit Command +excerpt: Hyperledger Composer Transaction Submit Command --- # composer transaction submit diff --git a/packages/composer-website/jekylldocs/reference/connectionprofile.md b/packages/composer-website/jekylldocs/reference/connectionprofile.md index 8981eb7d26..f49e83d7b3 100644 --- a/packages/composer-website/jekylldocs/reference/connectionprofile.md +++ b/packages/composer-website/jekylldocs/reference/connectionprofile.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Connection Profile +title: Hyperledger Composer - Connection Profile category: reference sidebar: sidebars/reference.md excerpt: Overview of the Connection Profiles diff --git a/packages/composer-website/jekylldocs/reference/cto_language.md b/packages/composer-website/jekylldocs/reference/cto_language.md index 6ecba2549f..74c91c0972 100644 --- a/packages/composer-website/jekylldocs/reference/cto_language.md +++ b/packages/composer-website/jekylldocs/reference/cto_language.md @@ -1,19 +1,19 @@ --- layout: default -title: Fabric Composer - Modeling Language +title: Hyperledger Composer - Modeling Language category: reference sidebar: sidebars/reference.md -excerpt: Guide to the Fabric Composer modeling language +excerpt: Guide to the Hyperledger Composer modeling language --- -# Fabric Composer Modeling Language +# {{site.data.conrefs.composer_full}} Modeling Language --- -Fabric Composer includes an Object-Oriented modeling language that is used to define +{{site.data.conrefs.composer_full}} includes an Object-Oriented modeling language that is used to define the domain model for a business network definition. -A Fabric Composer CTO file is composed of the following elements: +A {{site.data.conrefs.composer_full}} CTO file is composed of the following elements: 1. A single namespace. All resource declarations within the file are implicitly in this namespace. @@ -40,7 +40,7 @@ Assets, Participants and Transactions are class definitions. The concepts of Asset, Participant and Transaction may be considered to be different stereotypes of the class type. -A class in Fabric Composer is referred to as a Resource Definition. Therefore an +A class in {{site.data.conrefs.composer_full}} is referred to as a Resource Definition. Therefore an Asset (instance) has-an Asset Definition. A resource definition has the following properties: diff --git a/packages/composer-website/jekylldocs/reference/glossary.md b/packages/composer-website/jekylldocs/reference/glossary.md index 8592f0a0ae..e41db08021 100644 --- a/packages/composer-website/jekylldocs/reference/glossary.md +++ b/packages/composer-website/jekylldocs/reference/glossary.md @@ -20,13 +20,13 @@ From [Wikipedia](https://en.wikipedia.org/wiki/Blockchain_(database)) **Hyperledger** is the name of the Linux Foundation project to produce an open blockchain platform that is ready for business. It will provide an implementation of the shared ledger, smart contracts, privacy and consensus mechanisms. It will not provide any value added services (like monitoring or cloud hosting). IBM is one of many sponsors of the Hyperledger project. -# Fabric Composer Narrative +# {{site.data.conrefs.composer_full}} Narrative An **Economic Business Network** refers to the organizations that work together to take part in the digital business network. In many (all!) such networks there are multiple organisations that need to correlate their business process. In addition, in some industries, there are regulators that oversee the market. For example, within the food distribution network, the regulator is DEFRA in the UK or the Department of Agriculture in the US. To have a system that, for example, tracks food assets and the participants in the network, is very applicable to a Blockchain's quality of service. However, writing direct to the Hyperledger's core SDK requires a very low level API - and one that is not readily available or accessible to in-house developers. There is a high barrier to entry for practically solving business problems. So to help address this problem the ..tbc -**Fabric Composer** +**{{site.data.conrefs.composer_full}}** -Fabric Composer has been developed to permit architects and developers to use a runtime, tooling, client and administration APIs, that runs utilising a Hyperledger blockchain to provide a business-centric programming model, the starting point for this is the ...tbc +{{site.data.conrefs.composer_full}} has been developed to permit architects and developers to use a runtime, tooling, client and administration APIs, that runs utilising a Hyperledger blockchain to provide a business-centric programming model, the starting point for this is the ...tbc **Domain Specific Language** that they can use to describe the ...tbc @@ -46,14 +46,14 @@ Fabric Composer has been developed to permit architects and developers to use a **Business Network Archive** that can be deployed as an administrative action to the Composer system running on a Hyperledger fabric. -# Development of a system using Fabric Composer +# Development of a system using {{site.data.conrefs.composer_full}} There are two 'phases' to running an application using the Composer framework; the Business Network Definition should be deployed to a Hyperledger Fabric; then the application will run against this fabric, but using APIs applicable to the business model. The Composer system is defined in a number of [modules](../reference/MeetTheModules.html). -**Fabric Composer Client API** This is the API that is used by applications to connect to a business network and submit transactions. These end applications might be either command line, gui web applications using for example Angular-2. These APIs permit CRUD operations on the assets that have been defined in the model. It also permits the submission of the transactions to be executed to update assets for example. +**{{site.data.conrefs.composer_full}} Client API** This is the API that is used by applications to connect to a business network and submit transactions. These end applications might be either command line, gui web applications using for example Angular-2. These APIs permit CRUD operations on the assets that have been defined in the model. It also permits the submission of the transactions to be executed to update assets for example. -**Fabric Composer Admin API** is an administrative API to build admin applications. This can deploy and update business network definitions on the Composer fabric runtime. +**{{site.data.conrefs.composer_full}} Admin API** is an administrative API to build admin applications. This can deploy and update business network definitions on the Composer fabric runtime. To facilitate the application development process there are helper tools to permit the development. diff --git a/packages/composer-website/jekylldocs/reference/index.md b/packages/composer-website/jekylldocs/reference/index.md index 020052882f..5441dde782 100644 --- a/packages/composer-website/jekylldocs/reference/index.md +++ b/packages/composer-website/jekylldocs/reference/index.md @@ -2,14 +2,14 @@ layout: default title: Reference category: reference -excerpt: Fabric Composer module info +excerpt: Hyperledger Composer module info --- ## Reference - Overview --- ->The Reference section serves to provide more detailed information about subjects such as Fabric Composer, its modules and components, the Domain Specific language, APIs, Transaction Processors and so on. +>The Reference section serves to provide more detailed information about subjects such as {{site.data.conrefs.composer_full}}, its modules and components, the Domain Specific language, APIs, Transaction Processors and so on. --- diff --git a/packages/composer-website/jekylldocs/reference/js_scripts.md b/packages/composer-website/jekylldocs/reference/js_scripts.md index bbf6fccaa1..d46791761b 100644 --- a/packages/composer-website/jekylldocs/reference/js_scripts.md +++ b/packages/composer-website/jekylldocs/reference/js_scripts.md @@ -1,6 +1,6 @@ --- layout: default -title: Fabric Composer - Transaction Processor Functions +title: Hyperledger Composer - Transaction Processor Functions category: reference sidebar: sidebars/reference.md excerpt: Creating transaction processor functions in Javascript @@ -10,7 +10,7 @@ excerpt: Creating transaction processor functions in Javascript --- -A Fabric Composer Business Network Definition is composed of a set of model files +A {{site.data.conrefs.composer_full}} Business Network Definition is composed of a set of model files and a set of scripts. The scripts may contain transaction processor functions that implement the transactions defined in the Business Network Definition's model files. diff --git a/packages/composer-website/jekylldocs/support/changelog.md b/packages/composer-website/jekylldocs/support/changelog.md index e31267d238..8aa9beb0e2 100644 --- a/packages/composer-website/jekylldocs/support/changelog.md +++ b/packages/composer-website/jekylldocs/support/changelog.md @@ -1,8 +1,8 @@ --- layout: default -title: Fabric Composer Release Change Log +title: Hyperledger Composer Release Change Log category: support -excerpt: Fabric Composer Release Change Log +excerpt: Hyperledger Composer Release Change Log --- ## Change Log @@ -62,4 +62,4 @@ excerpt: Fabric Composer Release Change Log - [ab5a857](https://github.com/fabric-composer/fabric-composer/commit/ab5a857ed9bf4e24845738f95c17e8cf2a5de591) Adding transaction submit CLI reference doc and a couple of quick fixes. (#531) (@EdProsser) - [cd3b7aa](https://github.com/fabric-composer/fabric-composer/commit/cd3b7aa4e77142acd964843277353a6f8fae9201) Add support for mspid to hlfv1 (#512) (@davidkel) - [4233519](https://github.com/fabric-composer/fabric-composer/commit/4233519dcef42c0e990efc96a75ff70d46aafc99) feat(v1): Extract Identity from signer certificate (#526) (@davidkel) -- [6d6820a](https://github.com/fabric-composer/fabric-composer/commit/6d6820a848a39fb77991480f7fed72349d29eaae) Automatic version bump to 0.5.6 (@fabric-composer-app) \ No newline at end of file +- [6d6820a](https://github.com/fabric-composer/fabric-composer/commit/6d6820a848a39fb77991480f7fed72349d29eaae) Automatic version bump to 0.5.6 (@fabric-composer-app) diff --git a/packages/composer-website/jekylldocs/support/index.md b/packages/composer-website/jekylldocs/support/index.md index ebebbb77a8..3a8356f2ea 100644 --- a/packages/composer-website/jekylldocs/support/index.md +++ b/packages/composer-website/jekylldocs/support/index.md @@ -1,6 +1,6 @@ --- layout: support -title: Fabric Composer - Support +title: Hyperledger Composer - Support Sidebar: sidebars/support.md category: support --- diff --git a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md index 3b12738e26..2f6bae7a25 100644 --- a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md +++ b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md @@ -1,9 +1,9 @@ --- layout: default -title: Getting Started with Fabric Composer +title: Getting Started with Hyperledger Composer category: start sidebar: sidebars/tutorials.md -excerpt: Getting Started with Fabric Composer +excerpt: Getting Started with Hyperledger Composer --- # Running a sample with the CLI @@ -50,10 +50,10 @@ transaction RegisterPropertyForSale identified by transactionId{ } ``` -The applications we're going to look at are going to store a number of (pretend) land titles, and mark them for sale. All this will be using the Fabric Composer backed by a real blockchain in the shape of a locally executing Hyperledger Fabric. +The applications we're going to look at are going to store a number of (pretend) land titles, and mark them for sale. All this will be using the {{site.data.conrefs.composer_full}} backed by a real blockchain in the shape of a locally executing Hyperledger Fabric. ## But what is an asset? -An asset is a term used to describe things of value both in the physical world and the equally real intangible world. These are stored in Asset Registries. Participants can act on these assets by submitting transactions. With the features of a blockchain provided by the Hyperledger Fabric, an application using Fabric Composer has a single source of truth for the state of these assets and their history. +An asset is a term used to describe things of value both in the physical world and the equally real intangible world. These are stored in Asset Registries. Participants can act on these assets by submitting transactions. With the features of a blockchain provided by the Hyperledger Fabric, an application using {{site.data.conrefs.composer_full}} has a single source of truth for the state of these assets and their history. It's worth reading the [introduction](../introduction/introduction.html) page to get an idea of how everything fits together. The [Glossary](../reference/glossary.md) provides a detailed description of each term. @@ -64,7 +64,7 @@ The first thing to do is to ensure that you have a suitable system ready for dev **Ensure that you have followed the steps in our [Quickstart](./quickstart.md) before continuing!** -Let's go ahead and make a change to start to show how easy it is to develop with Fabric Composer. +Let's go ahead and make a change to start to show how easy it is to develop with {{site.data.conrefs.composer_full}}. ### Clone the Repository and Install Dependencies First clone the repository that contains the Business Network Definition (note this is not the same as the sample-applications repository). @@ -104,7 +104,7 @@ function onRegisterPropertyForSale(propertyForSale) { ### Update the Business Network Definition In a real-life scenario at this point you would edit `package.json` to increment the version number in the `DigitalProperty-Network` directory and publish this to npm. Please do npt publish to the DigitalProperty-Network in npm. -What we'll do therefore is adopt a different approach to create the Business Network Archive. From within the DigitalProperty-Network directory.. +What we'll do therefore is adopt a different approach to create the Business Network Archive. From within the DigitalProperty-Network directory. ```bash $ composer archive create --sourceType dir --sourceName . @@ -196,12 +196,12 @@ info: [Composer-GettingStarted] ## Digging Deeper -* `scripts/download-hyperledger.sh` This is a shell script that will download and tag the docker images for Hyperledger v0.6. It is important to note that this script will also delete the Fabric Composer Connection Profiles. This is important if you have connected to other Hyperledger Fabrics, or have changed the default ports that Hyperledger uses.`npm install` uses this script. +* `scripts/download-hyperledger.sh` This is a shell script that will download and tag the docker images for Hyperledger v0.6. It is important to note that this script will also delete the {{site.data.conrefs.composer_full}} Connection Profiles. This is important if you have connected to other Hyperledger Fabrics, or have changed the default ports that Hyperledger uses.`npm install` uses this script. * `scripts/start-hyperledger.sh` This is a shell script that starts the Hyperledger Fabric, this will also wait to make sure the Hyperledger fabric has started. `npm run startHLF` can also be used to call this script. * `scripts/stop-hyperledger.sh` This is the opposite of the start script, and will stop the Hyperledger Fabric - but it critically does not delete or remove any state. Therefore it canbe restarted with the start script. `npm run stopHLF` can also be used to call this script. -* `scripts/teardown.sh` This will stop and remove all the docker images related to Hyperledger fabric. This can be used to do an effective clean-up of the Hyperledger Fabric and the Fabric Composer Connection Profiles. +* `scripts/teardown.sh` This will stop and remove all the docker images related to Hyperledger fabric. This can be used to do an effective clean-up of the Hyperledger Fabric and the {{site.data.conrefs.composer_full}} Connection Profiles. **Composer CLI** @@ -215,14 +215,14 @@ This lists the deployed business network details. `-n` is the name of the busine **Sample Applications** -There are 3 sample Javascript applications that use the Fabric Composer Client API to perform operations on the business network. These are applications that specific to the business network that has been defined in this Digital Property Network. +There are 3 sample Javascript applications that use the {{site.data.conrefs.composer_full}} Client API to perform operations on the business network. These are applications that specific to the business network that has been defined in this Digital Property Network. * `node cli.js landregistry submit` This applications connects, and submits a transaction. * `node cli.js landregistry list` This lists the contents of the asset registries that have been defined in the business network. * `node cli.js landregistry bootstrap` This applications puts some pretend assets into the registries to work with. ### Completed! -We have downloaded the Hyperledger docker containers and stated a fabric. We have used the Fabric Composer Command line to deploy and update the DigitalProperty Network. We have used some Javascript applications in node.js to list assets and submit transactions to work on those assets. A simple change and update has been made to one of the transaction functions. +We have downloaded the Hyperledger docker containers and stated a fabric. We have used the {{site.data.conrefs.composer_full}} Command line to deploy and update the DigitalProperty Network. We have used some Javascript applications in node.js to list assets and submit transactions to work on those assets. A simple change and update has been made to one of the transaction functions. If you want to continue exploring, check out our other Getting Started guides: diff --git a/packages/composer-website/jekylldocs/tutorials/getting-started-playground.md b/packages/composer-website/jekylldocs/tutorials/getting-started-playground.md index c8ad7e8684..053e143401 100644 --- a/packages/composer-website/jekylldocs/tutorials/getting-started-playground.md +++ b/packages/composer-website/jekylldocs/tutorials/getting-started-playground.md @@ -1,24 +1,24 @@ --- layout: default -title: Installing and running the Fabric Composer Playground +title: Installing and running the Hyperledger Composer Playground category: start sidebar: sidebars/tutorials.md -excerpt: Installing and running the Fabric Composer Playground +excerpt: Installing and running the Hyperledger Composer Playground --- -# Installing and running the Fabric Composer Playground +# Installing and running the {{site.data.conrefs.composer_full}} Playground -This tutorial will take you through how to install and run the Fabric Composer Playground. +This tutorial will take you through how to install and run the {{site.data.conrefs.composer_full}} Playground. -The Fabric Composer Playground is a web development experience that allows you to develop a business network definition, deploy that business network definition to a running instance of Hyperledger Fabric, and test the deployed business network by working with assets, participants, and transactions. +The {{site.data.conrefs.composer_full}} Playground is a web development experience that allows you to develop a business network definition, deploy that business network definition to a running instance of Hyperledger Fabric, and test the deployed business network by working with assets, participants, and transactions. -Fabric Composer Playground can also be used in a "browser only" mode, without a running instance of Hyperledger Fabric. When used in this mode, all the functionality of Fabric Composer Playground is available, but all of the data (business networks, assets, participants, and transactions) is persisted into browser local storage. +{{site.data.conrefs.composer_full}} Playground can also be used in a "browser only" mode, without a running instance of Hyperledger Fabric. 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. -This tutorial will show you how to start a Hyperledger Fabric instance for use with Fabric Composer Playground by using Docker Compose. If you already have a running instance of Hyperledger Fabric, or you only want to work in "browser only" mode, then skip to [alternative installation options](#installationoptions). +This tutorial will show you how to start a Hyperledger Fabric instance for use with {{site.data.conrefs.composer_full}} Playground by using Docker Compose. If you already have a running instance of Hyperledger Fabric, or you only want to work in "browser only" mode, then skip to [alternative installation options](#installationoptions). # Prerequisites -In order to install Fabric Composer Playground, you need the following software installed: +In order to install {{site.data.conrefs.composer_full}} Playground, you need the following software installed: * Docker Engine 1.12.3 or greater @@ -72,7 +72,7 @@ The Docker Compose file describes a multi-container application that is made up This container will use ports 8080 -In a terminal or command prompt, navigate to the directory that you downloaded the `docker-compose.yml` file into, and run the following commands to start a Hyperledger Fabric instance and Fabric Composer Playground: +In a terminal or command prompt, navigate to the directory that you downloaded the `docker-compose.yml` file into, and run the following commands to start a Hyperledger Fabric instance and {{site.data.conrefs.composer_full}} Playground: ``` docker pull hyperledger/fabric-baseimage:x86_64-0.1.0 @@ -109,17 +109,17 @@ Verify that no errors occurred. If you see an error similar to the following err If you see this error, ensure that all of these ports are free before you run any commands. -If everything started OK, you should be able to access Fabric Composer Playground by clicking on this link: http://localhost:8080 +If everything started OK, you should be able to access {{site.data.conrefs.composer_full}} Playground by clicking on this link: http://localhost:8080 # Alternative installation options -If you have an existing Hyperledger Fabric instance you want to use with Fabric Composer Playground, then you can install the playground without installing another Hyperledger Fabric instance. The playground can then be configured to connect to your existing Hyperledger Fabric instance by creating a connection profile with the required connection settings. +If you have an existing Hyperledger Fabric instance you want to use with {{site.data.conrefs.composer_full}} Playground, then you can install the playground without installing another Hyperledger Fabric instance. The playground can then be configured to connect to your existing Hyperledger Fabric instance by creating a connection profile with the required connection settings. -There are two options for installing the Fabric Composer Playground. +There are two options for installing the {{site.data.conrefs.composer_full}} Playground. You can choose to install using npm (the Node.js package manager), or you can choose to install with Docker. We recommend that you: -* Install using npm if you wish to run to Fabric Composer Playground on your local workstation. -* Install using Docker if you wish to run Fabric Composer Playground on a server or cloud platform. +* Install using npm if you wish to run to {{site.data.conrefs.composer_full}} Playground on your local workstation. +* Install using Docker if you wish to run {{site.data.conrefs.composer_full}} Playground on a server or cloud platform.

Note that the same set of features is available regardless of the installation method that you choose. @@ -128,7 +128,7 @@ Note that the same set of features is available regardless of the installation m ### Prerequisites -In order to install Fabric Composer Playground with npm, you need the following software installed: +In order to install {{site.data.conrefs.composer_full}} Playground with npm, you need the following software installed: * Node.js v4.6.2 or greater, or Node.js v6.x (note that Node.js v7.x is unsupported) @@ -170,7 +170,7 @@ In order to install Fabric Composer Playground with npm, you need the following ### Installation -You can install Fabric Composer Playground by running the following command in your terminal or command prompt: +You can install {{site.data.conrefs.composer_full}} Playground by running the following command in your terminal or command prompt: ``` sudo npm install -g composer-playground @@ -187,15 +187,15 @@ You should see the following output in your terminal or command prompt: ... ``` -Verify that no errors occurred. If any part of this process fails, then Fabric Composer Playground will fail to work correctly. You may see errors from a program called `node-gyp`. These errors indicate that your system is not set up correctly to build Node.js C/C++ native modules. You may need to install additional software to correct this error. +Verify that no errors occurred. If any part of this process fails, then {{site.data.conrefs.composer_full}} Playground will fail to work correctly. You may see errors from a program called `node-gyp`. These errors indicate that your system is not set up correctly to build Node.js C/C++ native modules. You may need to install additional software to correct this error. -You can then start Fabric Composer Playground by running the following command in your terminal or command prompt: +You can then start {{site.data.conrefs.composer_full}} Playground by running the following command in your terminal or command prompt: ``` composer-playground ``` -A web browser will be automatically opened once the playground has started, but should that not happen you should be able to access Fabric Composer Playground by clicking on this link: http://localhost:8080 +A web browser will be automatically opened once the playground has started, but should that not happen you should be able to access {{site.data.conrefs.composer_full}} Playground by clicking on this link: http://localhost:8080 This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned! @@ -203,7 +203,7 @@ This tutorial is now **complete**. We plan on extending this tutorial with a gui ### Prerequisites -In order to install Fabric Composer Playground with Docker, you need the following software installed: +In order to install {{site.data.conrefs.composer_full}} Playground with Docker, you need the following software installed: * Docker Engine 1.12.3 or greater @@ -224,7 +224,7 @@ In order to install Fabric Composer Playground with Docker, you need the followi ### Installation -You can install Fabric Composer Playground by running the following Docker command in your terminal or command prompt: +You can install {{site.data.conrefs.composer_full}} Playground by running the following Docker command in your terminal or command prompt: ``` docker run -d -p 8080:8080 fabriccomposer/composer-playground @@ -239,6 +239,6 @@ You should see the following output in your terminal or command prompt: Verify that no errors occurred. -You can then start Fabric Composer Playground by clicking on this link: http://localhost:8080 +You can then start {{site.data.conrefs.composer_full}} Playground by clicking on this link: http://localhost:8080 This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned! From b368825447a962230e03e02e7750b108e4e26e38 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Mon, 24 Apr 2017 17:36:02 +0100 Subject: [PATCH 04/33] Removing Fabric composer name --- .../jekylldocs/installing/manual_prerequisites.md | 2 +- .../composer-website/jekylldocs/installing/prerequisites.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md index d2252efde0..18f635334f 100644 --- a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md @@ -39,7 +39,7 @@ The Docker Engine is essential for running system tests and running the HyperLed ## Optional Installs ### 1. Installing an editor -Fabric Composer allows you to edit its project files with any editor. +{{site.data.conrefs.composer_full}} allows you to edit its project files with any editor. However, we recommend either using Atom or Visual Studio Code as both have excellent support for Javascript development. We have even created an experimental CTO file syntax highlighting plugin for Atom. diff --git a/packages/composer-website/jekylldocs/installing/prerequisites.md b/packages/composer-website/jekylldocs/installing/prerequisites.md index 1d75a746a6..cdfd77dd54 100644 --- a/packages/composer-website/jekylldocs/installing/prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/prerequisites.md @@ -55,7 +55,7 @@ docker-compose version 1.11.1, build 7c5d5e4 ## Optional Installs ### 1. Installing an editor -Fabric Composer allows you to edit its project files with any editor. +{{site.data.conrefs.composer_full}} allows you to edit its project files with any editor. However, we recommend either using Atom or Visual Studio Code as both have excellent support for Javascript development. We have even created an experimental CTO file syntax highlighting plugin for Atom. From c7c1139cc30701d915e031f84900130cb55b59ae Mon Sep 17 00:00:00 2001 From: EdProsser Date: Mon, 24 Apr 2017 17:48:51 +0100 Subject: [PATCH 05/33] Moving images for REST API doc --- .../images/loopback-1.png | Bin .../images/loopback-2.png | Bin .../images/loopback-3.png | Bin .../images/loopback-4.png | Bin .../images/loopback-5.png | Bin 5 files changed, 0 insertions(+), 0 deletions(-) rename packages/composer-website/jekylldocs/{applications => integrating}/images/loopback-1.png (100%) rename packages/composer-website/jekylldocs/{applications => integrating}/images/loopback-2.png (100%) rename packages/composer-website/jekylldocs/{applications => integrating}/images/loopback-3.png (100%) rename packages/composer-website/jekylldocs/{applications => integrating}/images/loopback-4.png (100%) rename packages/composer-website/jekylldocs/{applications => integrating}/images/loopback-5.png (100%) diff --git a/packages/composer-website/jekylldocs/applications/images/loopback-1.png b/packages/composer-website/jekylldocs/integrating/images/loopback-1.png similarity index 100% rename from packages/composer-website/jekylldocs/applications/images/loopback-1.png rename to packages/composer-website/jekylldocs/integrating/images/loopback-1.png diff --git a/packages/composer-website/jekylldocs/applications/images/loopback-2.png b/packages/composer-website/jekylldocs/integrating/images/loopback-2.png similarity index 100% rename from packages/composer-website/jekylldocs/applications/images/loopback-2.png rename to packages/composer-website/jekylldocs/integrating/images/loopback-2.png diff --git a/packages/composer-website/jekylldocs/applications/images/loopback-3.png b/packages/composer-website/jekylldocs/integrating/images/loopback-3.png similarity index 100% rename from packages/composer-website/jekylldocs/applications/images/loopback-3.png rename to packages/composer-website/jekylldocs/integrating/images/loopback-3.png diff --git a/packages/composer-website/jekylldocs/applications/images/loopback-4.png b/packages/composer-website/jekylldocs/integrating/images/loopback-4.png similarity index 100% rename from packages/composer-website/jekylldocs/applications/images/loopback-4.png rename to packages/composer-website/jekylldocs/integrating/images/loopback-4.png diff --git a/packages/composer-website/jekylldocs/applications/images/loopback-5.png b/packages/composer-website/jekylldocs/integrating/images/loopback-5.png similarity index 100% rename from packages/composer-website/jekylldocs/applications/images/loopback-5.png rename to packages/composer-website/jekylldocs/integrating/images/loopback-5.png From 9e9301174a15d5d317f6a66a5f19221db098161d Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 25 Apr 2017 09:58:22 +0100 Subject: [PATCH 06/33] Fabric Composer Name removal --- .../jekylldocs/installing/manual_prerequisites.md | 10 +++++----- .../jekylldocs/installing/prerequisites.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md index 6ba84d9cfe..447fa9fee4 100644 --- a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md @@ -54,7 +54,7 @@ This is probably already installed on most Linux machines. Pay particular attent However, we recommend either using Atom or Visual Studio Code as both have excellent support for Javascript development. We have even created an experimental CTO file syntax highlighting plugin for Atom. ======= -Fabric Composer allows you to edit its project files with any editor. We recommend using either Atom or Visual Studio Code, as not only do both have excellent support for Javascript development, a CTO file syntax highlighting plugin exists for these editors. +{{site.data.conrefs.composer_full}} allows you to edit its project files with any editor. We recommend using either Atom or Visual Studio Code, as not only do both have excellent support for Javascript development, a CTO file syntax highlighting plugin exists for these editors. >>>>>>> refs/remotes/hyperledger/master @@ -66,7 +66,7 @@ Fabric Composer allows you to edit its project files with any editor. We recomme Suggested Plugins: -* [Atom Composer Syntax Highlighter](https://github.ibm.com/Blockchain-WW-Labs/Concerto-Atom) A plugin for model file highlighting. +* [Atom Composer Syntax Highlighter](https://github.ibm.com/Blockchain-WW-Labs/Concerto-Atom) A plugin for model file highlighting. * [File Icons](https://atom.io/packages/file-icons) is a useful UI enhancement to show different icons for different files. @@ -78,8 +78,8 @@ Extensions may be installed into VS Code by searching the Extensions repository * Composer VS Code Plugin. Provides syntax highlighting for CTO files within VS Code -* ESLint. Integrates ESLint into VS Code. +* ESLint. Integrates ESLint into VS Code. -* TSLint. Integrates the tslint linter for the TypeScript language into VS Code. +* TSLint. Integrates the tslint linter for the TypeScript language into VS Code. -* EditorConfig for VS Code. Enables the definition and maintainance of consistent coding styles between different editors and IDEs. \ No newline at end of file +* EditorConfig for VS Code. Enables the definition and maintainance of consistent coding styles between different editors and IDEs. diff --git a/packages/composer-website/jekylldocs/installing/prerequisites.md b/packages/composer-website/jekylldocs/installing/prerequisites.md index 038adb7ac0..5260dbb196 100644 --- a/packages/composer-website/jekylldocs/installing/prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/prerequisites.md @@ -66,7 +66,7 @@ This is probably already installed on most Linux machines. Pay particular attent However, we recommend either using Atom or Visual Studio Code as both have excellent support for Javascript development. We have even created an experimental CTO file syntax highlighting plugin for Atom. ======= -Fabric Composer allows you to edit its project files with any editor. We recommend using either Atom or Visual Studio Code, as not only do both have excellent support for Javascript development, a CTO file syntax highlighting plugin exists for these editors. +{{site.data.conrefs.composer_full}} allows you to edit its project files with any editor. We recommend using either Atom or Visual Studio Code, as not only do both have excellent support for Javascript development, a CTO file syntax highlighting plugin exists for these editors. >>>>>>> refs/remotes/hyperledger/master @@ -78,7 +78,7 @@ Fabric Composer allows you to edit its project files with any editor. We recomme Suggested Plugins: -* [Atom Composer Syntax Highlighter](https://github.ibm.com/Blockchain-WW-Labs/Concerto-Atom) A plugin for model file highlighting. +* [Atom Composer Syntax Highlighter](https://github.ibm.com/Blockchain-WW-Labs/Concerto-Atom) A plugin for model file highlighting. * [File Icons](https://atom.io/packages/file-icons) is a useful UI enhancement to show different icons for different files. @@ -90,8 +90,8 @@ Extensions may be installed into VS Code by searching the Extensions repository * Composer VS Code Plugin. Provides syntax highlighting for CTO files within VS Code -* ESLint. Integrates ESLint into VS Code. +* ESLint. Integrates ESLint into VS Code. -* TSLint. Integrates the tslint linter for the TypeScript language into VS Code. +* TSLint. Integrates the tslint linter for the TypeScript language into VS Code. -* EditorConfig for VS Code. Enables the definition and maintainance of consistent coding styles between different editors and IDEs. \ No newline at end of file +* EditorConfig for VS Code. Enables the definition and maintainance of consistent coding styles between different editors and IDEs. From d5571f6e9d2994ac1bd6ae069cc7c69075e8dfea Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 25 Apr 2017 10:22:06 +0100 Subject: [PATCH 07/33] Fabric Composer name removal --- .../jekylldocs/installing/quickstart.md | 8 +++--- .../integrating/getting-started-rest-api.md | 25 ++++++++++++------- .../tutorials/getting-started-cmd-line.md | 4 +-- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/packages/composer-website/jekylldocs/installing/quickstart.md b/packages/composer-website/jekylldocs/installing/quickstart.md index f284b8bf2b..c5eefe121e 100644 --- a/packages/composer-website/jekylldocs/installing/quickstart.md +++ b/packages/composer-website/jekylldocs/installing/quickstart.md @@ -108,7 +108,7 @@ $ npm test > getting-started@1.0.0 bootstrapAssets /home/ibm/samples/sample-applications/packages/getting-started > node cli.js landregistry bootstrap -info: [Composer-GettingStarted] Fabric Composer: Getting Started application +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started application info: [Composer-GettingStarted] Adding default land titles to the asset registry info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.6 info: [Composer-GettingStarted] LandRegistry:_bootstrapTitles getting asset registry for "net.biz.digitalPropertyNetwork.LandTitle" @@ -125,7 +125,7 @@ info: [Composer-GettingStarted] Command completed successfully. > getting-started@1.0.0 listAssets /home/ibm/samples/sample-applications/packages/getting-started > node cli.js landregistry list -info: [Composer-GettingStarted] Fabric Composer: Getting Started application +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started application info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.6 info: [Composer-GettingStarted] listTitles Getting the asset registry info: [Composer-GettingStarted] listTitles Getting all assets from the registry. @@ -146,13 +146,13 @@ info: [Composer-GettingStarted] Command completed successfully. > getting-started@1.0.0 submitTransaction /home/ibm/samples/sample-applications/packages/getting-started > node cli.js landregistry submit && node cli.js landregistry list -info: [Composer-GettingStarted] Fabric Composer: Getting Started application +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started application info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.6 info: [Composer-GettingStarted] updateForSale Getting assest from the registry. info: [Composer-GettingStarted] updateForSale Submitting transaction info: [Composer-GettingStarted] Transaction Submitted info: [Composer-GettingStarted] Command completed successfully. -info: [Composer-GettingStarted] Fabric Composer: Getting Started application +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started application info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.6 info: [Composer-GettingStarted] listTitles Getting the asset registry info: [Composer-GettingStarted] listTitles Getting all assets from the registry. 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 b609ad9c39..d73ed8ea0a 100644 --- a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md +++ b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md @@ -24,7 +24,7 @@ $ npm run listAssets > getting-started@1.0.0 listAssets /home/matthew/github_lenny/sample-applications/packages/getting-started > node cli.js landregistry list -info: [Composer-GettingStarted] Fabric Composer: Getting Started appliation +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started appliation info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.22 info: [Composer-GettingStarted] listTitles Getting the asset registry info: [Composer-GettingStarted] listTitles Getting all assest from the registry. @@ -65,17 +65,24 @@ composer-rest-server You will then be asked to enter a few simple details about your business network. ```bash - _____ _ _ ____ - | ___| __ _ | |__ _ __ (_) ___ / ___| ___ _ __ ___ _ __ ___ ___ ___ _ __ - | |_ / _` | | '_ \ | '__| | | / __| _____ | | / _ \ | '_ ` _ \ | '_ \ / _ \ / __| / _ \ | '__| - | _| | (_| | | |_) | | | | | | (__ |_____| | |___ | (_) | | | | | | | | |_) | | (_) | \__ \ | __/ | | - |_| \__,_| |_.__/ |_| |_| \___| \____| \___/ |_| |_| |_| | .__/ \___/ |___/ \___| |_| - |_| + + _ _ _ _ +| | | |_ _ _ __ ___ _ __| | ___ __| | __ _ ___ _ __ +| |_| | | | | '_ \ / _ \ '__| |/ _ \/ _` |/ _` |/ _ \ '__| +| _ | |_| | |_) | __/ | | | __/ (_| | (_| | __/ | +|_| |_|\__, | .__/ \___|_| |_|\___|\__,_|\__, |\___|_| + |___/|_| |___/ + ____ + / ___|___ _ __ ___ _ __ ___ ___ ___ _ __ +| | / _ \| '_ ` _ \| '_ \ / _ \/ __|/ _ \ '__| +| |__| (_) | | | | | | |_) | (_) \__ \ __/ | + \____\___/|_| |_| |_| .__/ \___/|___/\___|_| + |_| ? Enter your Fabric Connection Profile Name: defaultProfile ? Enter your Business Network Identifier : digitalproperty-network ? Enter your Fabric username : WebAppAdmin ? Enter your secret: DJY27pEnl16d -Loopback Connector for Fabric Composer +Loopback Connector for Hyperledger Composer Models Loaded Now Browse your REST API at http://0.0.0.0:3000/explorer ``` @@ -151,7 +158,7 @@ $ npm run listAssets > getting-started@1.0.0 listAssets /home/matthew/github_lenny/sample-applications/packages/getting-started > node cli.js landregistry list -info: [Composer-GettingStarted] Fabric Composer: Getting Started appliation +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started appliation info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.22 info: [Composer-GettingStarted] listTitles Getting the asset registry info: [Composer-GettingStarted] listTitles Getting all assest from the registry. diff --git a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md index 2f6bae7a25..239d658d46 100644 --- a/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md +++ b/packages/composer-website/jekylldocs/tutorials/getting-started-cmd-line.md @@ -170,14 +170,14 @@ $ npm run submitTransaction > getting-started@1.0.0 submitTransaction /home/matthew/github_lenny/sample-applications/packages/getting-started > node cli.js landregistry submit && node cli.js landregistry list -info: [Composer-GettingStarted] Fabric Composer: Getting Started appliation +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started appliation info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.22 info: [Composer-GettingStarted] updateForSale Getting assest from the registry. info: [Composer-GettingStarted] updateForSale Submitting transaction info: [Composer-GettingStarted] Transaction Submitted undefined info: [Composer-GettingStarted] Command completed successfully. -info: [Composer-GettingStarted] Fabric Composer: Getting Started appliation +info: [Composer-GettingStarted] Hyperledger Composer: Getting Started appliation info: [Composer-GettingStarted] LandRegistry: businessNetworkDefinition obtained digitalproperty-network@0.0.22 info: [Composer-GettingStarted] listTitles Getting the asset registry info: [Composer-GettingStarted] listTitles Getting all assest from the registry. From f451c3e47f39e65b0808cab0ccbfb7c59e0fd76c Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 25 Apr 2017 12:38:34 +0100 Subject: [PATCH 08/33] Other name changes (Stack Overflow, GitHub, Rocket.Chat, JavaScript) --- packages/composer-website/jekylldocs/_includes/foot.html | 2 +- .../composer-website/jekylldocs/_includes/footerbar.html | 2 +- .../composer-website/jekylldocs/_layouts/support.html | 6 +++--- .../jekylldocs/applications/getting-started-nodejs-app.md | 2 +- .../jekylldocs/installing/manual_prerequisites.md | 4 ++-- .../jekylldocs/installing/prerequisites.md | 2 +- .../composer-website/jekylldocs/managing/github-oauth.md | 8 ++++---- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/composer-website/jekylldocs/_includes/foot.html b/packages/composer-website/jekylldocs/_includes/foot.html index de46081dff..1bca59b6f8 100644 --- a/packages/composer-website/jekylldocs/_includes/foot.html +++ b/packages/composer-website/jekylldocs/_includes/foot.html @@ -8,7 +8,7 @@
  • - Github + GitHub
  • diff --git a/packages/composer-website/jekylldocs/_includes/footerbar.html b/packages/composer-website/jekylldocs/_includes/footerbar.html index e545a59733..67646101d8 100644 --- a/packages/composer-website/jekylldocs/_includes/footerbar.html +++ b/packages/composer-website/jekylldocs/_includes/footerbar.html @@ -8,7 +8,7 @@
  • - Github + GitHub
  • diff --git a/packages/composer-website/jekylldocs/_layouts/support.html b/packages/composer-website/jekylldocs/_layouts/support.html index 13c33d293a..a698efc1ca 100644 --- a/packages/composer-website/jekylldocs/_layouts/support.html +++ b/packages/composer-website/jekylldocs/_layouts/support.html @@ -12,7 +12,7 @@

    • -

    We're building a community to help people use and contribute to Hyperledger Composer: either join our team discussion on Rocket.chat, or ask us a question on Stackoverflow. We'd also love to hear your thoughts or feedback on what we're doing!

    +

    We're building a community to help people use and contribute to Hyperledger Composer: either join our team discussion on Rocket.Chat, or ask us a question on Stackoverflow. We'd also love to hear your thoughts or feedback on what we're doing!


    And that's not all: if you're a developer, come join us on GitHub. Browse our code, or send us a pull request (and we'll love you forever).

    @@ -22,10 +22,10 @@

    -

    Hyperledger Rocket Chat

    +

    Hyperledger Rocket.Chat

    -

    You will need a Linux Foundation id, or alternatively you can log in with Facebook, Github, Google, or OpenStack.

    +

    You will need a Linux Foundation id, or alternatively you can log in with Facebook, GitHub, Google, or OpenStack.

    Let's chat
    diff --git a/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md b/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md index b20c6bab32..9ec9d33ada 100644 --- a/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md +++ b/packages/composer-website/jekylldocs/applications/getting-started-nodejs-app.md @@ -12,7 +12,7 @@ excerpt: Getting Started with a Hyperledger Composer node.js application We'll walk through the sample node.js applications here. The git repo is the GettingStarted repo that was cloned for the Getting Started. The [`landregistry.js`](https://github.com/fabric-composer/sample-applications/blob/master/packages/getting-started/lib/landRegistry.js) file contains a class to the represent the land regsitry and contains methods for listing the land titles, adding default titles, and submitting the transaction. -This has been implemented using a javascript class; however you are free to structure your code as you wish. The framework's API is agnostic to this. +This has been implemented using a JavaScript class; however you are free to structure your code as you wish. The framework's API is agnostic to this. The application is also setup as a command line driven application using yargs (see the files in the cmd directory). We'll look at section of functionality in turn after first looking at the modules that are required and how to connect to a {{site.data.conrefs.composer_full}} hosted application on the Hyperledger Fabric. diff --git a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md index 447fa9fee4..e4e80a9a69 100644 --- a/packages/composer-website/jekylldocs/installing/manual_prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/manual_prerequisites.md @@ -10,7 +10,7 @@ excerpt: How to install the development pre-requisites manually --- -The essential tools you will need are *npm*, *docker*, *docker-compose* and a code editor, for example *Atom* or *VSCode*. Samples are held in Github so *git* will be needed as well. +The essential tools you will need are *npm*, *docker*, *docker-compose* and a code editor, for example *Atom* or *VSCode*. Samples are held in GitHub so *git* will be needed as well. Automatic installations scripts are available for [Ubuntu](./prerequisites.md) @@ -25,7 +25,7 @@ The recommended *minimum* versions are: ### 1. Installing NVM We highly recommend installing NVM to easily install and manage versions of [node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/). The main runtime uses node.js and npm is used for package management and dependency installation. The runtime requires a version higher than v4.6.0. -[Official nvm Github repository](https://github.com/creationix/nvm) +[Official nvm GitHub repository](https://github.com/creationix/nvm) ### 2. Kernel Packages If running on Ubuntu Trusty or Utopic, it is necessary to obtain additional Kernel packages to enable use of the [AUFS storage driver](https://docs.docker.com/engine/userguide/storagedriver/aufs-driver/#renaming-directories-with-the-aufs-storage-driver) for Docker. diff --git a/packages/composer-website/jekylldocs/installing/prerequisites.md b/packages/composer-website/jekylldocs/installing/prerequisites.md index 5260dbb196..e44f0049a9 100644 --- a/packages/composer-website/jekylldocs/installing/prerequisites.md +++ b/packages/composer-website/jekylldocs/installing/prerequisites.md @@ -10,7 +10,7 @@ excerpt: How to install the development pre-requisites --- -The essential tools you will need are *npm*, *docker*, *docker-compose* and a code editor for example *Atom* or *VSCode*. Samples are held in Github so *git* will be needed as well. +The essential tools you will need are *npm*, *docker*, *docker-compose* and a code editor for example *Atom* or *VSCode*. Samples are held in GitHub so *git* will be needed as well. The recommended *minimum* versions are: *Docker*: v1.12.3 diff --git a/packages/composer-website/jekylldocs/managing/github-oauth.md b/packages/composer-website/jekylldocs/managing/github-oauth.md index 54c8013e20..bc3a63bf51 100644 --- a/packages/composer-website/jekylldocs/managing/github-oauth.md +++ b/packages/composer-website/jekylldocs/managing/github-oauth.md @@ -1,16 +1,16 @@ --- layout: default -title: Task - Enable OAuth with Github +title: Task - Enable OAuth with GitHub category: tasks sidebar: sidebars/managing.md -excerpt: How to enable OAuth with Github +excerpt: How to enable OAuth with GitHub --- -# Enable OAuth with Github +# Enable OAuth with GitHub To enable importing of samples without receiving an error when the rate limit is hit follow these steps. -1. Go to [Github OAuth Applications](https://github.com/settings/developers). +1. Go to [GitHub OAuth Applications](https://github.com/settings/developers). 2. Register a new application. - The `Authorization callback URL` should be set to `localhost:/github`. 3. On the command line navigate to the `composer-connector-server` config directory. From 95ebad255683c75bb3d5644a68d3c313546e0537 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 25 Apr 2017 16:30:51 +0100 Subject: [PATCH 09/33] wording updates and bug splats --- .../jekylldocs/applications/index.md | 32 ------------------- .../jekylldocs/installing/installingindex.md | 2 ++ .../integrating/getting-started-rest-api.md | 2 +- .../integrating/integrating-index.md | 2 +- 4 files changed, 4 insertions(+), 34 deletions(-) delete mode 100644 packages/composer-website/jekylldocs/applications/index.md diff --git a/packages/composer-website/jekylldocs/applications/index.md b/packages/composer-website/jekylldocs/applications/index.md deleted file mode 100644 index ba2470214b..0000000000 --- a/packages/composer-website/jekylldocs/applications/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: Hyperledger Composer Quickstart -category: start -excerpt: Getting Started with Hyperledger Composer ---- - -## Getting Started - Overview ---- - - GET READY
    - ---- - ->This section provides a set of guides that will help you explore the functionality of {{site.data.conrefs.composer_full}} in a hands-on fashion. -Before you pick a guide, you should make sure you've followed the essential {{site.data.conrefs.composer_full}} setup steps in Quickstart: -[Developer Quickstart](./quickstart.md) - - ---- - -Explore Getting Started: - -[Running a sample with the CLI](./getting-started-cmd-line.md) - -[Coding a Business Network Definition](./getting-started-coding-bnd.md) - -[Generating a REST API](./getting-started-rest-api.md) - -[Writing a node.js app](./getting-started-nodejs-app.md) - -[Installing and running the playground](./getting-started-playground.md) diff --git a/packages/composer-website/jekylldocs/installing/installingindex.md b/packages/composer-website/jekylldocs/installing/installingindex.md index c04bf02564..9a046a0135 100644 --- a/packages/composer-website/jekylldocs/installing/installingindex.md +++ b/packages/composer-website/jekylldocs/installing/installingindex.md @@ -15,6 +15,8 @@ If you want to develop and test applications, connect to a running {{site.data.c If you want a more guided "Getting Started" experience, see our [Tutorials and Getting Started guides](../tutorials/tutorialindex.html). +After installing, create a connection profile to connect to a running {{site.data.conrefs.hyperledger_fabric_full}} instance. See [creating a connection profile](../installing/createconnectionprofile.html) + --- ## Related Links 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 d73ed8ea0a..8da41eb3a0 100644 --- a/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md +++ b/packages/composer-website/jekylldocs/integrating/getting-started-rest-api.md @@ -10,7 +10,7 @@ excerpt: Generating a REST API --- -This guide will show how to generate a REST API for the Digital Property business network. This api will be dynamically generated by using [LoopBack](https://loopback.io/doc/index.html) from the specified Business Network Model. What is generated is not a generic API, but is specifically configured to let you interact with the assets you have specified. +This guide will show how to generate a REST API for the Digital Property sample business network. This api will be dynamically generated by using [LoopBack](https://loopback.io/doc/index.html) from the specified Business Network Model. What is generated is not a generic API, but is specifically configured to let you interact with the assets you have specified. To get started with using this to create a REST interface to a Business Network, follow the steps below. If you've not followed the [Getting Started](../installing/quickstart.md) guide yet, it's worth following that first so you have {{site.data.conrefs.composer_full}} up and running on Hyperledger. diff --git a/packages/composer-website/jekylldocs/integrating/integrating-index.md b/packages/composer-website/jekylldocs/integrating/integrating-index.md index 59a90daf3d..dbec6f79be 100644 --- a/packages/composer-website/jekylldocs/integrating/integrating-index.md +++ b/packages/composer-website/jekylldocs/integrating/integrating-index.md @@ -10,6 +10,6 @@ excerpt: How to create a new Connection Profile --- -{{site.data.conrefs.composer_full}} can be integrated with existing systems by using a Loopback API. Integrating existing systems allows you to pull data from already existing business systems and convert it to assets or participants in a {{site.data.conrefs.composer_short}} business network. +{{site.data.conrefs.composer_full}} can be integrated with existing systems by using a Loopback API. Integrating existing systems allows you to pull data from existing business systems and convert it to assets or participants in a {{site.data.conrefs.composer_short}} business network. For instructions on setting up a Loopback API, see [Generating a REST API](../integrating/getting-started-rest-api.html). From dac8b5e97278b84858a174519c7faa769daf653e Mon Sep 17 00:00:00 2001 From: EdProsser Date: Tue, 25 Apr 2017 16:42:21 +0100 Subject: [PATCH 10/33] ToC Updates --- .../jekylldocs/_includes/sidebars/applications.md | 2 +- .../jekylldocs/_includes/sidebars/businessnetworks.md | 2 +- .../jekylldocs/_includes/sidebars/installing.md | 2 +- .../jekylldocs/_includes/sidebars/integrating.md | 2 +- .../jekylldocs/_includes/sidebars/introduction.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/problems.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/reference.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/support.md | 2 +- .../composer-website/jekylldocs/_includes/sidebars/tutorials.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/applications.md b/packages/composer-website/jekylldocs/_includes/sidebars/applications.md index 8f7c601e67..d75b2c3352 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/applications.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/applications.md @@ -7,7 +7,7 @@ [Writing a node.js application](../applications/getting-started-nodejs-app.html) [Generating a REST API](../applications/rest-api-server.html) **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md index 388cca24cd..822bde3425 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md @@ -13,7 +13,7 @@ [Test a business network definition](../business-network/testing.html) **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md index 30736c885d..186dc56c8d 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md @@ -8,7 +8,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md b/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md index f93a14d8e0..ba6cbabe41 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/integrating.md @@ -5,7 +5,7 @@ **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** [Using Loopback to generate a REST API for your business network](../integrating/getting-started-rest-api.html) -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md index c159cf857e..ac11aa7007 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/introduction.md @@ -5,7 +5,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/problems.md b/packages/composer-website/jekylldocs/_includes/sidebars/problems.md index ad09d531ce..53eeef167b 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/problems.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/problems.md @@ -4,7 +4,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** [Diagnosing problems](../problems/diagnostics.html) **[Reference](../reference/MeetTheModules.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/reference.md b/packages/composer-website/jekylldocs/_includes/sidebars/reference.md index 7db2381284..24d57c8dbb 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/reference.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/reference.md @@ -4,7 +4,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** [Meet the Modules](../reference/MeetTheModules.html ) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/support.md b/packages/composer-website/jekylldocs/_includes/sidebars/support.md index 9829c70a19..0504ff149a 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/support.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/support.md @@ -4,7 +4,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md b/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md index 95a2209701..1a1ae5282a 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/tutorials.md @@ -7,7 +7,7 @@ **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** -**[Managing and Operating](../managing/participant-add.html)** +**[Managing and Operating](../managing/managingindex.html)** **[Determining Problems](../problems/diagnostics.html)** **[Reference](../reference/MeetTheModules.html)** **[Support](../support/index.html)** From e1cbf5dc9a3b91241df6fce316574272d1a08c80 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Wed, 26 Apr 2017 16:23:41 +0100 Subject: [PATCH 11/33] HLv1 docs updates, couple more bug splats. --- .../_includes/sidebars/businessnetworks.md | 2 +- .../_includes/sidebars/installing.md | 2 +- .../installing/createconnectionprofile.md | 59 +++++----- .../jekylldocs/installing/quickstart.md | 102 ++++++------------ .../jekylldocs/introduction/introduction.md | 17 ++- .../jekylldocs/introduction/key-concepts.md | 11 +- 6 files changed, 77 insertions(+), 116 deletions(-) diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md index 822bde3425..54550fc521 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/businessnetworks.md @@ -9,7 +9,7 @@ [Create a business network definition](../business-network/bnd-define.html) [Publish a business network definition](../business-network/bnd-publish.html) [Publish a business domain model](../business-network/model-publish.html) -[Update a business network definition on Fabric](../business-network/runtime-update.html) +[Update a business network definition on Composer](../business-network/runtime-update.html) [Test a business network definition](../business-network/testing.html) **[Writing Applications](../applications/genapp.html)** **[Integrating Existing Systems](../integrating/integrating-index.html)** diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md index 186dc56c8d..59a441af68 100644 --- a/packages/composer-website/jekylldocs/_includes/sidebars/installing.md +++ b/packages/composer-website/jekylldocs/_includes/sidebars/installing.md @@ -3,7 +3,7 @@ **[Installing](../installing/installingindex.html)** [Prerequisites](../installing/prerequisites.html) [Quickstart](../installing/quickstart.html) -[Start a Fabric runtime](../installing/runtime-start.html) +[Start a Composer runtime](../installing/runtime-start.html) [Creating a network connection profile](../installing/createconnectionprofile.html) **[Defining Business Networks](../business-network/businessnetwork.html)** **[Writing Applications](../applications/genapp.html)** diff --git a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md index 89a26d2a44..62f43988c1 100644 --- a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md +++ b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md @@ -1,16 +1,16 @@ --- layout: default -title: Task - Creating a Connection Profile +title: Task - Creating a connection profile category: tasks sidebar: sidebars/installing.md -excerpt: How to create a new Connection Profile +excerpt: How to create a new connection profile --- # Creating a new Connection Profile --- -A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect to a running fabric. More information about Connection Profiles can be found [here](../reference/connectionprofile.html) +A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect to a running Hyperledger Fabric instance. More information about Connection Profiles can be found [here](../reference/connectionprofile.html) ## Procedure @@ -18,16 +18,16 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t ``` cd $HOME/.composer-connection-profiles ``` -2. Create a new profile folder +2. Create a new profile folder. ``` mkdir ./MyProfile ``` - then navigate into the new profile folder +3. Navigate into the new profile folder. ``` cd MyProfile ``` -3. Using your favourite text editor, create a new file called `connection.json` that contains the following information for Hyperledger Fabric V0.6 - +4. Create a new file called `connection.json` that contains the following information for either Hyperledger Fabric v0.6 or v1.0. + If you are creating a connection profile for Hyperledger Fabric 0.6, use the following format: ``` { "type": , @@ -37,31 +37,34 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t "eventHubURL": } ``` -4. Using your favourite text editor, create a new file called `connection.json` that contains the following information as an example for Hyperledger Fabric V1.0 - + If you are creating a connection profile for Hyperledger Fabric 1.0, use the following format: ``` { - "type": "hlfv1", - "orderers": [ - { - "url": "grpc://localhost:7050" - } - ], - "ca": "http://localhost:7054", - "peers": [ + "type": "hlfv1", + "orderers": [ + "grpc://localhost:7050" + ], + "ca": "http://localhost:7054", + "peers": [ { - "requestURL":"grpc://localhost:7051", - "eventURL":"grpc://localhost:7053" + "requestURL": "grpc://localhost:7051", + "eventURL": "grpc://localhost:7053" }, { - "requestURL":"grpc://localhost:7056", - "eventURL":"grpc://localhost:7058" + "requestURL": "grpc://localhost:7056", + "eventURL": "grpc://localhost:7058" } - ], - "keyValStore": "/Users/Fenglian/.hfc-key-store", - "channel": "mychannel", - "mspID": "Org1MSP", - "deployWaitTime": "300", - "invokeWaitTime": "100" - } + ], + "keyValStore": "/home/matthew/.hfc-key-store", + "channel": "mychannel", + "mspID": "Org1MSP", + "deployWaitTime": "300", + "invokeWaitTime": "100" + } ``` +--- + +## What next? + +* Learn more about [defining business networks](../business-network/businessnetwork.html) +* Writing [applications for your solution](../applications/genapp.html) diff --git a/packages/composer-website/jekylldocs/installing/quickstart.md b/packages/composer-website/jekylldocs/installing/quickstart.md index c5eefe121e..4fac86a66a 100644 --- a/packages/composer-website/jekylldocs/installing/quickstart.md +++ b/packages/composer-website/jekylldocs/installing/quickstart.md @@ -13,85 +13,51 @@ excerpt: Quickstart The steps below enable you to get started with the Composer sample application. -You can choose to install the latest **v0.6** Composer sample application (uses a Hyperledger Fabric v0.6 environment) or the **v1.0** sample application (uses a Hyperledger Fabric v1.0 environment) and give us feedback. +These steps will install the Composer sample application running against Hyperledger Fabric v1.0. To use Hyperledger Fabric v0.6 run the optional command in step 2. +## Before you begin -**1. Check that your system has the required software (at the required versions) installed:** - -**Operating Systems:** Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12 - -**Docker Engine:** Version 1.12.x - -**Docker-Compose:** Version 1.8.x - -**Node:** 6.x (note version 7 is not supported) - -**npm:** 4.0.x - -**git:** 2.9.x - -If you need to update or install any pre-reqs, please refer to the install guides: -[Installing Pre-requisites](../installing/prerequisites.md) - -**2. Install the Composer command line tools:** - -``` -$ npm install -g composer-cli -``` - -**3. Clone the Composer Sample Applications Git repository:** - -In this step, **choose from either the v0.6 sample application or the v1.0 sample application** - the former will stand up a Hyperledger Fabric v0.6 environment ; the latter will stand up a newer Hyperledger Fabric v1.0 environment using a docker command sequence. - -**v0.6** +Check that your system has the required software (at the required versions) installed: ``` -$ git clone https://github.com/hyperledger/composer-sample-applications.git +Operating Systems: Ubuntu Linux 14.04 / 16.04 LTS (both 64-bit), or Mac OS 10.12 +Docker Engine: Version 1.12.x +Docker-Compose: Version 1.8.x +Node: 6.x (note version 7 is not supported) +npm: 4.0.x +git: 2.9.x ``` -**v1.0** +If you need to update or install any of the prerequisites, please refer to [installing prerequisites](../installing/prerequisites.md) -``` -$ git clone https://github.com/hyperledger/composer-sample-applications-hlfv1.git -``` +## Procedure -**4. Install the Getting Started Application:** +1. To install the Composer command line tools: + ``` + $ npm install -g composer-cli + ``` +2. Clone the Composer sample applications GitHub repository: + ``` + $ git clone https://github.com/hyperledger/composer-sample-applications.git + ``` + ***Optional:*** To run this sample with Hyperledger Fabric v0.6, run the following command. + ``` + npm set getting-started:fabric hlf + ``` +3. To install the getting started application run the following commands. + ``` + $ cd composer-sample-applications/packages/getting-started + $ npm install + ``` + Amongst the steps (described below), the command returns information about the deployed digital property network such as name, models, registries etc. -Change directory to the Composer sample application repository (v0.6 or v1.0) you wish to install - choose one of the following: + `npm install` runs several scripts that are packaged into the getting-started directory and uses the docker-compose `.yml` file mentioned below to pull/download the relevant Hyperledger Fabric docker images. -**v0.6** + There is [reference material](https://fabric-composer.github.io/reference/commands.html) for Composer CLI. -``` -$ cd composer-sample-applications/packages/getting-started -$ npm install -``` -**v1.0** +4. Run the `npm test` command. You should see output similar to that shown below (output below is for a v0.6 sample application) ``` -$ cd composer-sample-applications-hlfv1/packages/getting-started -$ npm install -``` - -Amongst the steps (described below), the command returns information about the deployed digital property network such as name, models, registries etc. - -***npm install*** - -`npm install` will run several scripts that are packaged into the getting-started directory and uses the docker-compose .yml file mentioned below to pull/download the relevant Hyperledger Fabric docker images. - -1. *scripts/download-hyperledger.sh* - This script pulls the required Hyperledger Fabric Docker images (v0.6 or v1.0, depending on the sample application repository cloned earlier). -2. *scripts/start-hyperledger.sh* - This uses the Docker yaml file to bring up the Hyperledger Fabric containers. -3. *composer archive create* - using Composer CLI, it creates an Business Network Archive (.bna) of the *npm* module *digitalproperty-network* and *archives* it into a file called *digitalPropertyNetwork.bna*. -4. *composer network deploy* - Deploys (in this case) the `digitalPropertyNetwork.bna` business network to the deployed Hyperledger Fabric environment, using the default Composer connection profile. -5. *composer network list* - Lists the contents of a deployed business network. - - -There is [Reference material](https://fabric-composer.github.io/reference/commands.html) for Composer CLI - -**5. Run the Getting Started Application:** - -Run the `npm test` command. You should see output similar to that shown below (output below is for a v0.6 sample application) - -```bash $ npm test > getting-started@1.0.0 test /home/ibm/samples/sample-applications/packages/getting-started > mocha --recursive && npm run bootstrapAssets && npm run listAssets && npm run submitTransaction @@ -173,13 +139,13 @@ info: [Composer-GettingStarted] Command completed successfully. ``` -***npm test*** +## Testing the application 1. `mocha --recursive` - Runs all unit tests in the */tests* directory. 2. `node cli.js landregistry bootstrap` - Run the bootstrap command to create two land titles owned by Fred Bloggs. 3. `node cli.js landregistry list` - Run the list command to list all of the assets in the LandTitles asset registry. 4. `node cli.js landregistry submit` - Run the submit command to submit a transaction that changes LandTitle *LID:1148*'s *ForSale*' property to *Yes*. -**Where next?** +## Where next? * Learn more about the Digital Property Network and running the tests in the first [Getting Started Tutorial](../tutorials/getting-started-cmd-line.md) diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index da579320a9..a61c344626 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -12,13 +12,13 @@ excerpt: Hyperledger Composer overview --- -You can use {{site.data.conrefs.composer_full}} to rapidly develop and deploy a blockchain solution; modeling your business network and integrating existing systems and data. +{{site.data.conrefs.composer_full} is an extensive, open development toolset and framework to make developing blockchain applications easier. Our primary goal is to accelerate time to value, and make it easier to integrate your blockchain applications with the existing business systems. You can use {{site.data.conrefs.composer_full}} to rapidly develop use cases and deploy a blockchain solution in weeks rather than months. {{site.data.conrefs.composer_full}} allows you to model your business network and integrate existing systems and data with your blockchain applications. -{{site.data.conrefs.composer_full}} requires and exploits the existing [Hyperledger Fabric blockchain](https://hyperledger.org) technology, using the blockchain consensus protocol to ensure that transactions are validated by business network participants. +{{site.data.conrefs.composer_full}} supports the existing [Hyperledger Fabric blockchain](https://hyperledger.org) infrastructure and runtime, and supports pluggable blockchain consensus protocols to ensure that transactions are validated according to policy by the designated business network participants. -Applications can consume the data from business networks, providing end users with simple and controlled access points. Existing data can also be integrated you modeled network, allowing complex systems and solutions to contribute data and . +Everyday applications can consume the data from business networks, providing end users with simple and controlled access points. -You can use {{site.data.conrefs.composer_full}} to quickly model your business network, containing your existing assets and the transactions related to them, whether your assets are tangible or intangible goods, services, or property. As part of your business network model, you define the transactions which are used to interact with assets. Business networks also include the participants who interact with them, each of which can be associated with a unique identity across multiple business networks. +You can use {{site.data.conrefs.composer_full}} to quickly model your current business network, containing your existing assets and the transactions related to them; assets are tangible or intangible goods, services, or property. As part of your business network model, you define the transactions which can interact with assets. Business networks also include the participants who interact with them, each of which can be associated with a unique identity, across multiple business networks. --- @@ -32,13 +32,8 @@ You can use {{site.data.conrefs.composer_full}} to quickly model your business n ## How does {{site.data.conrefs.composer_full}} work in practise? -<<<<<<< HEAD -For an example of a business network in action; a realtor can quickly model their business network; including houses and listings assets, buyers and homeowners as participants, and buying or selling houses, and creating and closing listings as transactions. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor can then create an application to present buyers and sellers with a simple user interface for viewing open listings and making offers. This business network could also be integrated with existing inventory system, adding new houses as assets and removing sold properties. Relevant other parties can be registered as participants, for example a land registry might interact with a buyer to transfer ownership of the land. -======= ---- +For an example of a business network in action; a realtor can quickly model their business network; including houses and listings assets, buyers and homeowners as participants, and buying or selling houses, and creating and closing listings as transactions. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor can then create an application to present buyers and sellers with a simple user interface for viewing open listings and making offers. This business network could also be integrated with existing inventory system, adding new houses as assets and removing sold properties. Relevant other parties can be registered as participants, for example a land registry might interact with a buyer to transfer ownership of the land. -For an example of a business network in action; a realtor may have a business network containing houses and listings as assets. Participants could include buyers and homeowners. Transactions might include buying or selling houses, and creating and closing listings. Participants can have their access to transactions restricted based on their role as either a buyer, seller, or realtor. The realtor may want to create an application to present buyers and sellers participants with a simple user interface for viewing open listings and making offers. This business network could also be integrated with the existing inventory system for the realtor, allowing for the addition of new houses as assets. Relevant other parties can be registered as participants whilst maintaining their own business network, for example a land registry might interact with a buyer winner to transfer ownership of the land. ->>>>>>> refs/remotes/fabric-composer/master --- @@ -46,4 +41,4 @@ For an example of a business network in action; a realtor may have a business ne --- -To get started with {{site.data.conrefs.composer_full}} right away, try the [{{site.data.conrefs.composer_full}} tutorials](../tutorials/tutorialindex.html), to learn more about {{site.data.conrefs.composer_full}} read [understanding {{site.data.conrefs.composer_full}}](../introduction/key-concepts.html), to get installed and trying the full product immediately go to [installing {{site.data.conrefs.composer_full}}](../installing/prerequisites.html). +To get started with {{site.data.conrefs.composer_full}} right away, try the [{{site.data.conrefs.composer_full}} tutorials](../tutorials/tutorialindex.html), to learn more about {{site.data.conrefs.composer_full}} read [understanding {{site.data.conrefs.composer_full}}](../introduction/key-concepts.html), to get installed and trying the full product immediately go to [installing {{site.data.conrefs.composer_full}}](../installing/prerequisites.html). diff --git a/packages/composer-website/jekylldocs/introduction/key-concepts.md b/packages/composer-website/jekylldocs/introduction/key-concepts.md index 1bd304fcc2..0c8fb99cf2 100644 --- a/packages/composer-website/jekylldocs/introduction/key-concepts.md +++ b/packages/composer-website/jekylldocs/introduction/key-concepts.md @@ -60,16 +60,13 @@ Transactions are the mechanism by which participants interact with assets. This The `composer-admin`, `composer-client`, and `composer-common` components contain the APIs to interact with a {{site.data.conrefs.composer_full}} runtime. The `composer-rest-server` component generates a unique RESTful API for interacting with your deployed business network. --- - From 9a2429061066963316124c2dc808cf716e49e803 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Wed, 26 Apr 2017 16:53:11 +0100 Subject: [PATCH 12/33] Last edit for HLv1 --- .../jekylldocs/installing/createconnectionprofile.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md index 62f43988c1..c5fd3df443 100644 --- a/packages/composer-website/jekylldocs/installing/createconnectionprofile.md +++ b/packages/composer-website/jekylldocs/installing/createconnectionprofile.md @@ -27,7 +27,7 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t cd MyProfile ``` 4. Create a new file called `connection.json` that contains the following information for either Hyperledger Fabric v0.6 or v1.0. - If you are creating a connection profile for Hyperledger Fabric 0.6, use the following format: + If you are creating a connection profile for Hyperledger Fabric v0.6, use the following format: ``` { "type": , @@ -37,7 +37,7 @@ A Connection Profile is used by {{site.data.conrefs.composer_full}} to connect t "eventHubURL": } ``` - If you are creating a connection profile for Hyperledger Fabric 1.0, use the following format: + If you are creating a connection profile for Hyperledger Fabric v1.0, use the following format: ``` { "type": "hlfv1", From dca7b3fdbd9485b89a005cf8c6cca27c85d2f064 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Thu, 27 Apr 2017 10:57:18 +0100 Subject: [PATCH 13/33] Whoops, bug splat --- packages/composer-website/jekylldocs/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/composer-website/jekylldocs/index.html b/packages/composer-website/jekylldocs/index.html index 842b9449ac..be125ba7cf 100644 --- a/packages/composer-website/jekylldocs/index.html +++ b/packages/composer-website/jekylldocs/index.html @@ -1,6 +1,6 @@ --- layout: indexbase -title: {{site.data.conrefs.composer_full}} - Create business networks and blockchain applications quickly for Hyperledger +title: Hyperledger Composer - Create business networks and blockchain applications quickly for Hyperledger ---
    From cf23ac07c6c8749e30993d346f0e89ae532572d4 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Thu, 27 Apr 2017 11:19:53 +0100 Subject: [PATCH 14/33] Another bug splat... --- .../composer-website/jekylldocs/introduction/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/composer-website/jekylldocs/introduction/introduction.md b/packages/composer-website/jekylldocs/introduction/introduction.md index a61c344626..7c13c51b36 100644 --- a/packages/composer-website/jekylldocs/introduction/introduction.md +++ b/packages/composer-website/jekylldocs/introduction/introduction.md @@ -12,7 +12,7 @@ excerpt: Hyperledger Composer overview --- -{{site.data.conrefs.composer_full} is an extensive, open development toolset and framework to make developing blockchain applications easier. Our primary goal is to accelerate time to value, and make it easier to integrate your blockchain applications with the existing business systems. You can use {{site.data.conrefs.composer_full}} to rapidly develop use cases and deploy a blockchain solution in weeks rather than months. {{site.data.conrefs.composer_full}} allows you to model your business network and integrate existing systems and data with your blockchain applications. +{{site.data.conrefs.composer_full}} is an extensive, open development toolset and framework to make developing blockchain applications easier. Our primary goal is to accelerate time to value, and make it easier to integrate your blockchain applications with the existing business systems. You can use {{site.data.conrefs.composer_full}} to rapidly develop use cases and deploy a blockchain solution in weeks rather than months. {{site.data.conrefs.composer_full}} allows you to model your business network and integrate existing systems and data with your blockchain applications. {{site.data.conrefs.composer_full}} supports the existing [Hyperledger Fabric blockchain](https://hyperledger.org) infrastructure and runtime, and supports pluggable blockchain consensus protocols to ensure that transactions are validated according to policy by the designated business network participants. From b8ce0082b89fe1592349674c909ebcdf39afb5a9 Mon Sep 17 00:00:00 2001 From: EdProsser Date: Fri, 28 Apr 2017 09:46:27 +0100 Subject: [PATCH 15/33] Quick fixes prereqs navbar --- .../jekylldocs/_includes/navbar.html | 2 +- .../jekylldocs/installing/manual_prerequisites.md | 12 +++--------- .../jekylldocs/installing/prerequisites.md | 12 +++--------- 3 files changed, 7 insertions(+), 19 deletions(-) diff --git a/packages/composer-website/jekylldocs/_includes/navbar.html b/packages/composer-website/jekylldocs/_includes/navbar.html index 82eb5e167e..86f18afdfd 100644 --- a/packages/composer-website/jekylldocs/_includes/navbar.html +++ b/packages/composer-website/jekylldocs/_includes/navbar.html @@ -9,7 +9,7 @@ - Fabric Composer + Hyperledger Composer