Doc fixes and playground links (#3304)

* Doc fixes and playground links Signed-off-by: Dave Kelsey <[email protected]> * change test Signed-off-by: Dave Kelsey <[email protected]>
hyperledger-archives · Feb 1, 2018 · a3752cd · a3752cd
1 parent 397292c
commit a3752cd
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 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
@@ -63,22 +63,22 @@ 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'
                           };
 
           service.setValuesFromObject(object);
 
           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
@@ -21,11 +21,11 @@ export class Config {
     this.title = 'Hyperledger Composer';
     this.banner = ['Hyperledger', 'Composer Playground'];
     this.links = {
-      docs: <string> 'https://hyperledger.github.io/composer/introduction/introduction.html',
-      tutorial: <string> 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html',
-      community: <string> 'https://hyperledger.github.io/composer/support/support-index.html',
+      docs: <string> 'https://hyperledger.github.io/composer/next/introduction/introduction.html',
+      tutorial: <string> 'https://hyperledger.github.io/composer/next/tutorials/playground-tutorial.html',
+      community: <string> 'https://hyperledger.github.io/composer/next/support/support-index.html',
       github: <string> 'https://github.com/hyperledger/composer',
-      install: <string> 'https://hyperledger.github.io/composer/installing/installing-index.html',
+      install: <string> 'https://hyperledger.github.io/composer/next/installing/installing-index.html',
       legal: <string> '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
@@ -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
@@ -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
@@ -35,7 +35,7 @@ <h1>Build Blockchain applications and business networks your way</h1>
 </div>
 <div class="homepage-callout">
   <div class="callout-copy">
-  <p><strong>Update Nov 28th: </strong>Version 0.16 has been released. Please see <a href="https://github.com/hyperledger/composer/releases">the release notes.</a></p>
+  <p><strong>Update Feb 1st 2018: </strong>Version 0.17.3 has been released. Please see <a href="https://github.com/hyperledger/composer/releases">the release notes.</a></p>
 </div>
 </div>
 <div class="trio">

diff --git 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);