Jsdoc and apidoc (#2354)

* jsdoc and apiinilne

Signed-off-by: Matthew B White <whitemat@uk.ibm.com>

* JSDoc at the original location, and link to it

Signed-off-by: Matthew B White <whitemat@uk.ibm.com>

* correct link on main page and remove between in filters

Signed-off-by: Matthew B White <whitemat@uk.ibm.com>

* correct gitignore for jsdoc

Signed-off-by: Matthew B White <whitemat@uk.ibm.com>

Author: mbwhite

.gitignore

@@ -53,8 +53,8 @@ jspm_packages
 packages/composer-website/linkresults.txt
 
 packages/composer-website/jsondata
-packages/composer-website/jekyll-docs/api-doc-inline
-
+packages/composer-website/jekylldocs/api-doc-inline
+packages/composer-website/jekylldocs/jsdoc
 packages/composer-playground/src/assets/npmlist.json
 
 packages/composer-systests/systestv1/tls/ca/fabric-ca-server.db

packages/composer-website/jekylldocs/business-network/query.md

@@ -16,7 +16,7 @@ Queries are an optional component of a business network definition, written in a
 
 Note: When using the {{site.data.conrefs.hlf_full}} v1.0 runtime {{site.data.conrefs.hlf_full}} must be configured to use CouchDB persistence.
 
-Filters are similar to queries, but use the LoopBack filter syntax, and can only be sent using the {{site.data.conrefs.composer_full}} REST API. Currently, only the `WHERE` LoopBack filter is supported. The supported operators within `WHERE` are: **=**, **and**, **or**, **gt**, **gte**, **lt**, **lte**, **between**, **neq**. Filters are submitted using a `GET` call against an asset type, participant type, or transaction type; the filter is then supplied as a parameter. Filters return the results from the specified class, and will not return results from classes extending the specified class.
+Filters are similar to queries, but use the LoopBack filter syntax, and can only be sent using the {{site.data.conrefs.composer_full}} REST API. Currently, only the `WHERE` LoopBack filter is supported. The supported operators within `WHERE` are: **=**, **and**, **or**, **gt**, **gte**, **lt**, **lte**, **neq**. Filters are submitted using a `GET` call against an asset type, participant type, or transaction type; the filter is then supplied as a parameter. Filters return the results from the specified class, and will not return results from classes extending the specified class.
 
 ## Types of Queries
 
@@ -83,14 +83,15 @@ Filters can only be submitted using the {{site.data.conrefs.composer_full}} REST
 
 *Please note*: Only the top level `WHERE` operator can have more than two operands.
 
-Currently, only the `WHERE` LoopBack filter is supported. The supported operators within `WHERE` are: **=**, **and**, **or**, **gt**, **gte**, **lt**, **lte**, **between**, **neq**. Filters can combine multiple operators, in the following example, an **and** operator is nested within an **or** operator.
+Currently, only the `WHERE` LoopBack filter is supported. The supported operators within `WHERE` are: **=**, **and**, **or**, **gt**, **gte**, **lt**, **lte**, **neq**. Filters can combine multiple operators, in the following example, an **and** operator is nested within an **or** operator.
 
 ```
 {"where":{"or":[{"and":[{"field1":"foo"},{"field2":"bar"}]},{"field3":"foobar"}]}}
 ```
-
+<!--
 The **between** operator returns values between the given range. It accepts numbers, datetime values, and strings. If supplied with strings, the **between** operator returns results between the supplied strings alphabetically. In the example below, the filter will return all resources where the driver property is alphabetically between _a_ and _c_, inclusively.
 
 ```
 {"where":{"driver":{"between": ["a","c"]}}}
 ```
+-->

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 Oct 11: </strong>Version 0.14 has been released.  To deliver major enhancements to the security model, this update may break existing projects.  Please see https://github.com/hyperledger/composer/releases</p>
+  <p><strong>Update Oct 11: </strong>Version 0.14 has been released.  To deliver major enhancements to the security model, this update may break existing projects.  Please see <a href="https://github.com/hyperledger/composer/releases">the release notes.</a></p>
 </div>
 </div>
 <div class="trio">

packages/composer-website/jekylldocs/jsdoc/index.html

@@ -1,12 +0,0 @@
----
----
- <html xmlns="http://www.w3.org/1999/xhtml">    
-  <head>      
-    <title>Hyperledger Composer</title>      
-    <meta http-equiv="refresh" content="0;URL='{{site.baseurl}}/api-doc-inline/api-doc-index.html'" />    
-  </head>    
-  <body> 
-    <p>This page has moved to a <a href="{{site.baseurl}}/api-doc-inline/api-doc-index.html">
-      {{site.baseurl}}/api-doc-inline/api-doc-index.html</a>.</p> 
-  </body>  
-</html>   

packages/composer-website/package.json

@@ -8,7 +8,8 @@
     "npm": ">=3"
   },
   "scripts": {
-    "doc": "npm run apiref && ./scripts/generate-uml.sh",
+    "jsdocpub": "jsdoc --pedantic --recurse -c ./jsdoc-template/jsdoc.conf -t ./jsdoc-template -a public,undefined -d ./jekylldocs/jsdoc -R ./jsdoc-template/JSDOC-README.md",
+    "doc": "npm run apiref && ./scripts/generate-uml.sh && npm run jsdocpub",
     "apiref": "mkdirp ./jsondata && ./scripts/generate-apidocs.1.sh",
     "docpub": "jsdoc --pedantic --recurse -c ./jsdoc-template/jsdoc.conf -t ./jsdoc-template -a public,undefined -d ./jekylldocs/jsdoc -R ./jsdoc-template/JSDOC-README.md",
     "docpriv": "jsdoc --pedantic --recurse -c ./jsdoc-template/jsdoc.conf -t ./jsdoc-template -a all -d ./jekylldocs/jsdoc-contrib -R ./jsdoc-template/JSDOC-README.md",

packages/composer-website/scripts/api-doc-index.md.tpl

@@ -11,6 +11,8 @@ index-order: 1200
 Hyperledger Composer  is an application development framework for building Blockchain applications based on Hyperledger. This is the JavaScript documentation for the Hyperledger Composer Client, Admin, and Runtime JavaScript APIs.
 
 
+The [original JSDoc format](../jsdoc/index.html) can still be found temporarily, whilst the new format is refinded. Please do send us your feedback.
+
 ## Overview
 The major components of Hyperledger Composer are:
 

packages/composer-website/scripts/generate-uml.sh

@@ -26,5 +26,6 @@ node ./node_modules/composer-common/lib/codegen/parsejs.js --format PlantUML --i
 
 echo $(date) Generating images for public and private APIs...
 node ./node_modules/composer-common/lib/tools/plantumltoimage.js --inputDir "$DIR/out/uml" --outputDir "$DIR/jekylldocs/api-doc-inline/diagrams"
+node ./node_modules/composer-common/lib/tools/plantumltoimage.js --inputDir "$DIR/out/uml" --outputDir "$DIR/jekylldocs/jsdoc/diagrams"
 #node ./node_modules/composer-common/lib/tools/plantumltoimage.js --inputDir "$DIR/out/uml-private" --outputDir "$DIR/out/diagrams-private"
 echo $(date) Processed UML files