BE-704 Online documentation-synchronizer

* dashboard image updated * updated run sync process Signed-off-by: nfrunza <nfrunza@gmail.com> Change-Id: Ifdde5c7e3caad2aa8e231d26e9568c7cca5c61ba
hyperledger-labs · Nov 14, 2019 · 7f063dc · 7f063dc
1 parent 4fedc3a
commit 7f063dc
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 69 deletions.
diff --git a/docs/source/_static/images/hl_dashboard.png b/docs/source/_static/images/hl_dashboard.png
diff --git a/docs/source/_static/images/hle_dashboard.png b/docs/source/_static/images/hle_dashboard.png
diff --git a/docs/source/_static/images/hle_tx_list.png b/docs/source/_static/images/hle_tx_list.png
diff --git a/docs/source/architecture/sync_configuration.rst b/docs/source/architecture/sync_configuration.rst
@@ -47,13 +47,11 @@ Configuration
     .. tab-container:: run_standalone
         :title: Run host (Standalone)
 
-							   .. code-block:: json
-
-														{
-															"sync": {
-															"type": "host"
-															}
-														}
+							  * From new terminal (if Sync Process in Standalone).
+
+										* ``cd blockchain-explorer/``
+										* ``./syncstart.sh`` (it will have the sync node up).
+										* ``./syncstop.sh`` (it will stop the sync node).
 
 
     .. tab-container:: run_local
@@ -65,7 +63,7 @@ Configuration
 											* ``./start.sh`` (it will have the backend up).
 											* ``./start.sh debug`` (it will have the backend in debug mode).
 											* ``./start.sh print`` (it will print help).
-											* Launch the URL ``http(s)://localhost:8080`` on a browser.
+											* Launch the URL ``http(s)://<host>:<port>`` on a browser.
 											* ``./stop.sh`` (it will stop the node server).
 
 
@@ -75,7 +73,7 @@ Configuration
 			* Please restart Explorer if any changes made to explorerconfig.json.
 
 			  * If the Hyperledger Explorer was used previously in your browser be sure to clear the cache before relaunching.
-			  * If Hyperledger Fabric network is deployed on other machine, please toggle DISCOVERY_AS_LOCALHOST in ``start.sh / syncstart.sh to 'false'``.
+			  * If Hyperledger Fabric network is deployed on other machine, please toggle ``DISCOVERY_AS_LOCALHOST`` in ``start.sh / syncstart.sh to 'false'``.
 
 
 

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -5,8 +5,6 @@
 Getting Started with Hyperledger Explorer
 =========================================
 
-TODO
-
 
 Hyperledger Explorer can run in your local environment or using docker. Minimum configuration allows you to get it setup up, and running
 in short time.
@@ -16,62 +14,19 @@ run HL Explorer successfully. Along with the instructions you may find useful
 by community through the `mail listings <https://lists.hyperledger.org/g/explorer/topics>`__  or
 `Rocket Chat <https://chat.hyperledger.org/channel/hyperledger-explorer>`__ hyperledger-explorer channel.
 
+.. important::
 
+	See `Release Notes <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md#10-release-notes---->`__ on supported Hyperledger Fabric and Explorer versions.
 
-
-Following are the software dependencies required to install and run hyperledger explorer:
-
-	* `Node.js <https://nodejs.org/en/>`__ 8.11.x (Note that v9.x is not yet supported)
-	* `PostgreSQL 9.5 or greater <https://www.postgresql.org/>`__
-	* `jq <https://stedolan.github.io/jq>`__, a lightweight and flexible command-line JSON processor
-	* Linux-based operating system, such as `Ubuntu <https://ubuntu.com/>`__ or MacOS
-
-Verified Docker versions supported:
-
-	* `Docker CE 18.09.2 or later <https://hub.docker.com/search/?type=edition&offering=community&operating_system=linux>`__
-	* `Docker Compose 1.14.0 <https://docs.docker.com/compose>`__
+..
 
 .. note::
 
-   See `Release Notes <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md#10-release-notes---->`__ on supported Hyperledger Fabric and Explorer versions.
-
-
-.. container:: content-tabs
-
-    .. tab-container:: local
-        :title: Run locally
-
-
-        Assuming that your environment has the required software dependencies, follow up `instructions <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md>`__  on how to setup Hyperledger Explorer to run in your local environment
-
-
-    .. tab-container:: cloud
-        :title: Run in cloud
-
-        Content for Running HL Explorer in cloud
-
-    .. tab-container:: docker
-        :title: Run in docker
-
-        Content for Running HL Explorer in docker
-
-    .. tab-container:: kubernetes
-        :title: Run 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>`__.
-
-
-
-
-
-
-
-
-.. add a short overview, and rely on links in current README of the github
+	Hyperledger Explorer project team did not test, or setup to run explorer in kubernetes, a contributor 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, please see `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/introduction.rst b/docs/source/introduction.rst
@@ -26,12 +26,12 @@ What are the key features of Hyperledger Explorer?
 		- Get real time notification of new blocks.
 
 
-Please proceed to next page, or click the link below to get familiar with Hyperledger Explorer screens.
+.. Please proceed to next page, or click the link below to get familiar with Hyperledger Explorer screens.
 
-.. toctree::
+.. .. toctree::
    :maxdepth: 1
 
-   presentation/index
+..   presentation/index
 
 
 

diff --git a/docs/source/presentation/hl_transaction_list.html b/docs/source/presentation/hl_transaction_list.html
@@ -13,9 +13,9 @@
 
 <p></p>
 <div class="container">
-	<input type="checkbox" id="hl_transaction_list">
-	<label for="hl_transaction_list">
-		<img src="../_static/images/hl_transaction_list.png">
+	<input type="checkbox" id="hle_tx_list">
+	<label for="hle_tx_list">
+		<img src="../_static/images/hle_tx_list.png">
 	</label>
 </div>
 

diff --git a/docs/source/presentation/index.rst b/docs/source/presentation/index.rst
@@ -40,7 +40,7 @@ Each panel reflects the historical, metrics, and the latest activity per selecte
 Latest blocks notification panel
 --------------------------------
 The latest block notification panel displays the block number, channel name, datahash, and the number of transactions per block.
-There is an  :guilabel:`icon link` if clicked, it will show the latest block details, and is located in the right most corner of the panel. In the picture below you can see
+There is an  :guilabel:`icon link` to show the latest block details, and is located in the right most corner of the panel. In the picture below you can see
 the block details accessed from the provided link.
 
 
@@ -108,7 +108,8 @@ The :guilabel:`Reset` button can be used to reset the date range, and the organi
 
 Transaction list
 -----------------
-Transaction list screen has almost identical functionality as the block list screen.
+Transaction list screen has almost identical functionality as the block list screen, the number of rows per page, up to 100, can be selected from
+the drop down, next and previous buttons allow to navigate the direction of results, back or forward.
 
 .. raw:: html
      :file: ./hl_transaction_list.html