From a3752cd51c5ade23e0f508186283c2ffdaee4a24 Mon Sep 17 00:00:00 2001 From: Dave Kelsey Date: Thu, 1 Feb 2018 12:33:55 +0000 Subject: [PATCH] Doc fixes and playground links (#3304) * Doc fixes and playground links Signed-off-by: Dave Kelsey * change test Signed-off-by: Dave Kelsey --- .../config/configStructure.service.spec.ts | 22 +++++++++---------- .../config/configStructure.service.ts | 8 +++---- .../jekylldocs/applications/node.md | 2 +- .../jekylldocs/business-network/historian.md | 2 +- .../composer-website/jekylldocs/index.html | 2 +- .../tutorials/playground-tutorial.md | 2 +- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts b/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts index a2e04fe1db..6ecd00cb74 100644 --- a/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts +++ b/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts @@ -63,11 +63,11 @@ describe('Config', () => { }; service.links = { - docs: 'https://hyperledger.github.io/composer/introduction/introduction.html', - tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html', - community: 'https://hyperledger.github.io/composer/support/support-index.html', + docs: 'https://hyperledger.github.io/composer/next/introduction/introduction.html', + tutorial: 'https://hyperledger.github.io/composer/next/tutorials/playground-tutorial.html', + community: 'https://hyperledger.github.io/composer/next/support/support-index.html', github: 'https://github.com/hyperledger/composer', - install: 'https://hyperledger.github.io/composer/installing/installing-index.html', + install: 'https://hyperledger.github.io/composer/next/installing/installing-index.html', legal: 'https://www.apache.org/licenses/LICENSE-2.0' }; @@ -75,10 +75,10 @@ describe('Config', () => { service.links.should.deep.equal({ docs: 'My Docs', - tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html', - community: 'https://hyperledger.github.io/composer/support/support-index.html', + tutorial: 'https://hyperledger.github.io/composer/next/tutorials/playground-tutorial.html', + community: 'https://hyperledger.github.io/composer/next/support/support-index.html', github: 'https://github.com/hyperledger/composer', - install: 'https://hyperledger.github.io/composer/installing/installing-index.html', + install: 'https://hyperledger.github.io/composer/next/installing/installing-index.html', legal: 'https://www.apache.org/licenses/LICENSE-2.0' }); }); @@ -105,11 +105,11 @@ describe('Config', () => { service.title.should.deep.equal('Hyperledger Composer'); service.banner.should.deep.equal(['Hyperledger', 'Composer Playground']); service.links.should.deep.equal({ - docs: 'https://hyperledger.github.io/composer/introduction/introduction.html', - tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html', - community: 'https://hyperledger.github.io/composer/support/support-index.html', + docs: 'https://hyperledger.github.io/composer/next/introduction/introduction.html', + tutorial: 'https://hyperledger.github.io/composer/next/tutorials/playground-tutorial.html', + community: 'https://hyperledger.github.io/composer/next/support/support-index.html', github: 'https://github.com/hyperledger/composer', - install: 'https://hyperledger.github.io/composer/installing/installing-index.html', + install: 'https://hyperledger.github.io/composer/next/installing/installing-index.html', legal: 'https://www.apache.org/licenses/LICENSE-2.0' }); diff --git a/packages/composer-playground/src/app/services/config/configStructure.service.ts b/packages/composer-playground/src/app/services/config/configStructure.service.ts index 8283d1db8c..37a4f71ad7 100644 --- a/packages/composer-playground/src/app/services/config/configStructure.service.ts +++ b/packages/composer-playground/src/app/services/config/configStructure.service.ts @@ -21,11 +21,11 @@ export class Config { this.title = 'Hyperledger Composer'; this.banner = ['Hyperledger', 'Composer Playground']; this.links = { - docs: 'https://hyperledger.github.io/composer/introduction/introduction.html', - tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html', - community: 'https://hyperledger.github.io/composer/support/support-index.html', + docs: 'https://hyperledger.github.io/composer/next/introduction/introduction.html', + tutorial: 'https://hyperledger.github.io/composer/next/tutorials/playground-tutorial.html', + community: 'https://hyperledger.github.io/composer/next/support/support-index.html', github: 'https://github.com/hyperledger/composer', - install: 'https://hyperledger.github.io/composer/installing/installing-index.html', + install: 'https://hyperledger.github.io/composer/next/installing/installing-index.html', legal: 'https://www.apache.org/licenses/LICENSE-2.0' }; this.analyticsID = null; diff --git a/packages/composer-website/jekylldocs/applications/node.md b/packages/composer-website/jekylldocs/applications/node.md index 50556ee9c8..72da53f3e4 100644 --- a/packages/composer-website/jekylldocs/applications/node.md +++ b/packages/composer-website/jekylldocs/applications/node.md @@ -162,4 +162,4 @@ What we need to do here is create a 'serializer'. This is able to create a reso * [**JavaScript API Documentation**](../api/api-doc-index.html) * [**Promises tutorial**](https://scotch.io/tutorials/understanding-javascript-promises-pt-i-background-basics) -* [** async/await tutorial**](https://codeburst.io/javascript-es-2017-learn-async-await-by-example-48acc58bad65) +* [**async/await tutorial**](https://codeburst.io/javascript-es-2017-learn-async-await-by-example-48acc58bad65) diff --git a/packages/composer-website/jekylldocs/business-network/historian.md b/packages/composer-website/jekylldocs/business-network/historian.md index ec0c8a4bd1..0fe86377eb 100644 --- a/packages/composer-website/jekylldocs/business-network/historian.md +++ b/packages/composer-website/jekylldocs/business-network/historian.md @@ -73,7 +73,7 @@ rule historianAccess{ ## Retrieving historian data -Data from the historian registry can be retrieved using either an API call, or queries. +Data from the historian registry can be retrieved using either an API call, or queries. All examples that follow make use of the async/await feature and assume that the code is encapsulated in a function with the `async` attribute. ### Using the client and REST APIs with historian diff --git a/packages/composer-website/jekylldocs/index.html b/packages/composer-website/jekylldocs/index.html index 6882d66639..4c8883f39e 100644 --- a/packages/composer-website/jekylldocs/index.html +++ b/packages/composer-website/jekylldocs/index.html @@ -35,7 +35,7 @@

Build Blockchain applications and business networks your way

-

Update Nov 28th: Version 0.16 has been released. Please see the release notes.

+

Update Feb 1st 2018: Version 0.17.3 has been released. Please see the release notes.

diff --git a/packages/composer-website/jekylldocs/tutorials/playground-tutorial.md b/packages/composer-website/jekylldocs/tutorials/playground-tutorial.md index 7f801a938c..c559b5dcac 100644 --- a/packages/composer-website/jekylldocs/tutorials/playground-tutorial.md +++ b/packages/composer-website/jekylldocs/tutorials/playground-tutorial.md @@ -104,7 +104,7 @@ For more information on writing transaction processor functions, check our [docu * @param {org.acme.mynetwork.Trade} trade - the trade to be processed * @transaction */ - function tradeCommodity(trade) { + async function tradeCommodity(trade) { trade.commodity.owner = trade.newOwner; let assetRegistry = await getAssetRegistry('org.acme.mynetwork.Commodity'); await assetRegistry.update(trade.commodity);