BE-679 Create online docs

* removed local paths * This is not complete Signed-off-by: nfrunza <nfrunza@gmail.com> Change-Id: I67ea203d92e8eaa23d0283253d4a373f1eb20221
hyperledger-labs · Aug 9, 2019 · edebabc · edebabc
1 parent 2c6eed5
commit edebabc
Show file tree

Hide file tree

Showing 35 changed files with 223 additions and 33 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,4 +31,7 @@ ssl-certs/*.csr
 0
 app/test/.nyc_output/
 docs/build/
+_build
+_static
+_templates
 *.DS_Store
diff --git a/README.md b/README.md
@@ -170,7 +170,7 @@ Connect to the PostgreSQL database and run DB status commands:
 - `\l`  View created fabricexplorer database.
 - `\d`  View created tables.
 
-If your Postgresql configured with TLS, read link [how to configure connection to Postgresql with TLS](./app/persistence/postgreSQL/CONFIGURE-TLS-CONNECTION-TO-POSTGRESQL.md) 
+If your Postgresql configured with TLS, read link [how to configure connection to Postgresql with TLS](./app/persistence/postgreSQL/CONFIGURE-TLS-CONNECTION-TO-POSTGRESQL.md)
 
 <a name="Authorization-Configuration" />
 

diff --git a/app/persistence/fabric/MetricService.js b/app/persistence/fabric/MetricService.js
@@ -127,15 +127,17 @@ class MetricService {
 	async getTxPerChaincodeGenerate(channel_genesis_hash) {
 		const txArray = [];
 		const c = await this.sql
-			.getRowsBySQlNoCondition(`select  c.name as chaincodename,channel.name as channelName ,c.version as version,c.channel_genesis_hash
+			.getRowsBySQlNoCondition(`select  c.name as chaincodename,channel.name as channelname ,c.version as version,c.channel_genesis_hash
        as channel_genesis_hash,c.path as path ,txcount  as c from chaincodes as c inner join channel on c.channel_genesis_hash=channel.channel_genesis_hash where  c.channel_genesis_hash='${channel_genesis_hash}' `);
 		if (c) {
 			c.forEach((item, index) => {
+				console.debug(' item ------------> ', item);
 				txArray.push({
 					chaincodename: item.chaincodename,
 					path: item.path,
 					version: item.version,
 					txCount: item.c,
+					channelName: item.channelname,
 					channel_genesis_hash: item.channel_genesis_hash
 				});
 			});

diff --git a/app/persistence/postgreSQL/CONFIGURE-TLS-CONNECTION-TO-POSTGRESQL.md b/app/persistence/postgreSQL/CONFIGURE-TLS-CONNECTION-TO-POSTGRESQL.md
@@ -5,12 +5,12 @@
 
 In order to configure TLS connection to Postgresql take next steps:
 
-- [Optional] pass environment variable `DATABASE_CERTS_PATH`, default is `/opt/explorer/db-certs` 
+- [Optional] pass environment variable `DATABASE_CERTS_PATH`, default is `/opt/explorer/db-certs`
 
 - put certificates into folder specified by `DATABASE_CERTS_PATH`. There should be three files:
 
     - `client-cert.pem`
     - `client-key.pem`
     - `server-ca.pem`
-    
+
 - pass environment variable `DATABASE_SSL_ENABLED=true`
diff --git a/app/platform/fabric/connection-profile/first-network.json b/app/platform/fabric/connection-profile/first-network.json
@@ -38,17 +38,17 @@
 			"mspid": "Org1MSP",
 			"fullpath": true,
 			"adminPrivateKey": {
-				"path": "/fabric-path/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/keystore/9b5e1e91c5e7ca0c0e83799586e729d027e4c1275f079b6c59584f50c7df1faa_sk"
+				"path": "/fabric-path/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/keystore/1bebc656f198efb4b5bed08ef42cf3b2d89ac86f0a6b928e7a172fd823df0a48_sk"
 			},
 			"signedCert": {
-				"path": "/fabric-path/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/signcerts/Admin@org1.example.com-cert.pem"
+				"path": "/fabric-path/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/signcerts/Admin@org1.example.com-cert.pem"
 			}
 		}
 	},
 	"peers": {
 		"peer0.org1.example.com": {
 			"tlsCACerts": {
-				"path": "/fabric-path/first-network/crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt"
+				"path": "/fabric-path/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt"
 			},
 			"url": "grpcs://localhost:7051",
 			"eventUrl": "grpcs://localhost:7053",

diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst
@@ -0,0 +1,25 @@
+Architecture Reference
+----------------------
+
+TODO
+~~~~
+
+.. short overview of the HL Explorer architecture
+
+
+.. toctree::
+   :maxdepth: 1
+
+   architecture/ui_presentation
+   architecture/backend
+
+
+
+
+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
+
+
diff --git a/docs/source/architecture/backend.rst b/docs/source/architecture/backend.rst
@@ -0,0 +1,17 @@
+Backend Layer
+===========================================
+
+An overview of the backend layer
+
+  TODO
+
+
+  .. .. image:: ../images/backend.png
+  .. :width: 850px
+
+.. toctree::
+   :maxdepth: 1
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/architecture/ui_presentation.rst b/docs/source/architecture/ui_presentation.rst
@@ -0,0 +1,19 @@
+UI Presentaion
+===========================================
+
+An overview of the UI presentation layer
+
+TODO
+
+.. add an overview
+
+.. image:: ../images/ui_presentation.png
+   :width: 850px
+
+
+.. toctree::
+   :maxdepth: 1
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = u'Hyperledger Explorer'
-copyright = u'Hyperledger Explorer Project is released under the Apache 2.0 license.'
+copyright = u'Hyperledger Explorer Project source code is released under the Apache 2.0 license'
 author = u'Hyperledger Explorer'
 
 # The short X.Y version
@@ -38,16 +38,30 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+
+# extensions = [
+#    'sphinx.ext.autodoc',
+#    'sphinx.ext.doctest',
+#    'sphinx.ext.intersphinx',
+#    'sphinx.ext.todo',
+#    'sphinx.ext.coverage',
+#    'sphinx.ext.mathjax',
+#    'sphinx.ext.ifconfig',
+#    'sphinx.ext.viewcode',
+#    'sphinx.ext.githubpages',
+#]
+
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
@@ -0,0 +1,25 @@
+.. :orphan:
+
+Glossary
+-----------------------------
+
+
+TODO
+
+.. add terms used in HL Explorer
+
+Membership
+
+
+
+
+
+
+
+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
+
+
diff --git a/docs/source/images/block_details.png b/docs/source/images/block_details.png
diff --git a/docs/source/images/block_hour.png b/docs/source/images/block_hour.png
diff --git a/docs/source/images/block_minute.png b/docs/source/images/block_minute.png
diff --git a/docs/source/images/blocks.png b/docs/source/images/blocks.png
diff --git a/docs/source/images/chaincodes.png b/docs/source/images/chaincodes.png
diff --git a/docs/source/images/channels.png b/docs/source/images/channels.png
diff --git a/docs/source/images/dashboard.png b/docs/source/images/dashboard.png
diff --git a/docs/source/images/dashboard_dark_theme.png b/docs/source/images/dashboard_dark_theme.png
diff --git a/docs/source/images/filter_transactions.png b/docs/source/images/filter_transactions.png
diff --git a/docs/source/images/network.png b/docs/source/images/network.png
diff --git a/docs/source/images/notification.png b/docs/source/images/notification.png
diff --git a/docs/source/images/notification_panel.png b/docs/source/images/notification_panel.png
diff --git a/docs/source/images/register_user.png b/docs/source/images/register_user.png
diff --git a/docs/source/images/transactions.png b/docs/source/images/transactions.png
diff --git a/docs/source/images/tx_details.png b/docs/source/images/tx_details.png
diff --git a/docs/source/images/tx_hour.png b/docs/source/images/tx_hour.png
diff --git a/docs/source/images/tx_min.png b/docs/source/images/tx_min.png
diff --git a/docs/source/images/ui_presentation.png b/docs/source/images/ui_presentation.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,19 +17,6 @@ Overview of Hyperledger Explorer
 ================================
 
 
-What are the key features of Hyperledger Explorer?
---------------------------------------------------
-
-			- Web application with a rich user interface, build using latest technologies, such as reactjs, Google material ui, and web-sockets.
-			- Blockchain module that can listen, and query a hyperledger fabric network.
-			- Utility that can :
-					- Get the latest status blocks, network, and chaincodes, view blocks, and transactions.
-					- Blocks and transactions metrics by hours, and minutes.
-					- Search, and filter blocks, transactions by date range and channels.
-					- Dynamically discover new channels and switch data presentation by channels.
-					- Get real time notification of new blocks.
-
-
 
 Table of contents
 =================
@@ -39,7 +26,10 @@ Table of contents
 
 
    introduction
+   architecture
+   tutorials
    CONTRIBUTING
+   glossary
 
 
 

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -1,16 +1,38 @@
 
-Hyperledger Explorer Tutorial
------------------------------
+Introduction
+============
+
+Hyperledger Explorer allows you to explore the entire blockchain of the `Hyperledger Fabric <https://www.hyperledger.org/projects/fabric>`__ platform.
+
+
+What are the key features of Hyperledger Explorer?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+			- Web application with a rich user interface, build using latest technologies, such as reactjs, Google material ui, and web-sockets.
+			- Blockchain module that can listen, and query a hyperledger fabric network.
+			- Utility that can:
+					- Get the latest status blocks, network, and chaincodes, view blocks, and transactions.
+					- Blocks and transactions metrics by hours, and minutes.
+					- Search, and filter blocks, transactions by date range and channels.
+					- Dynamically discover new channels and switch data presentation by channels.
+					- Get real time notification of new blocks.
+
+
+Getting Started with Hyperledger Explorer
+-----------------------------------------
 
 TODO
-~~~~
 
-List
+.. add an introduction on how to start using HLExplorer, short description with using images, and explanation what are the futures with notes on images
+.. located in blockchain-explorer/docs/source/images
+
+.. toctree::
+   :maxdepth: 1
+
+   architecture/ui_presentation
+
+
 
-* Architecture Reference
-* Operations Guides
-* Tutorials
-* Frequently Asked Questions
 
 
 

diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -0,0 +1,23 @@
+Tutorial
+--------
+
+In this tutorial we will try to highlight on how to configure and run Hyperledger Explorer in different environments.
+
+
+
+.. toctree::
+   :maxdepth: 1
+
+
+   tutorials/hl_explorer_local
+   tutorials/hl_explorer_docker
+   tutorials/hl_explorer_cloud
+   tutorials/hl_explorer_kubernetes
+
+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
+
+
diff --git a/docs/source/tutorials/hl_explorer_cloud.rst b/docs/source/tutorials/hl_explorer_cloud.rst
@@ -0,0 +1,13 @@
+Running HL Explorer in cloud
+*********************************
+
+
+
+TODO
+
+.. add steps how to run in cloud
+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/tutorials/hl_explorer_docker.rst b/docs/source/tutorials/hl_explorer_docker.rst
@@ -0,0 +1,12 @@
+Running HL Explorer in docker
+*****************************
+
+
+TODO
+
+.. a short overview, and use links to the current instructions on how to run in docker
+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/tutorials/hl_explorer_kubernetes.rst b/docs/source/tutorials/hl_explorer_kubernetes.rst
@@ -0,0 +1,14 @@
+.. :orphan:
+
+Running HL Explorer in kubernetes
+---------------------------------
+
+
+Hyperledger Explorer project team did not test, or setup to run explorer in kubernetes, but someone did a tremendous job in setting it,
+and added an explanation on how to set it up.
+If you're interested to experiment, and willing to give a try you're more than welcomed.
+Please let us know if you succeeded in `running explorer in kubernetes <https://github.com/feitnomore/hyperledger-fabric-kubernetes>`__.
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/tutorials/hl_explorer_local.rst b/docs/source/tutorials/hl_explorer_local.rst
@@ -0,0 +1,11 @@
+Running HL Explorer locally
+*********************************
+
+
+TODO
+
+.. add a short overview, and rely on links in current README of the github
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/