BE-678 Create online documentation

* Link updates, and docs Signed-off-by: nfrunza <nfrunza@gmail.com> Change-Id: I2e43f251fab53dc7c0672d94e2a1e38cf67dd22a
hyperledger-labs · Jul 11, 2019 · 0061fa0 · 0061fa0
1 parent 7cfb817
commit 0061fa0
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 57 deletions.
diff --git a/.gitignore b/.gitignore
@@ -31,3 +31,4 @@ ssl-certs/*.csr
 0
 app/test/.nyc_output/
 docs/build/
+*.DS_Store
diff --git a/docs/README.rst b/docs/README.rst
@@ -1,30 +1,34 @@
 
-<!-- (SPDX-License-Identifier: CC-BY-4.0) -->  <!-- Ensure there is a newline before, and after, this line -->
 
-## Hyperledger Explorer
+Hyperledger Explorer
+====================
 
-- [Project Lifecycle](project_lifecycle/README.md)
-- [Hyperledger Explorer functionalities](project_functionalities/README.md)
+`Project Lifecycle <project_lifecycle/README.md>`__
 
+`Hyperledger Explorer functionalities <project_functionalities/README.md>`__
 
 
-# Documentation README
 
-## Introduction
+Documentation README
+----------------------
+
+Introduction
+~~~~~~~~~~~~
 
 This document contains information on how the Hyperledger Explorer documentation is
 built and published as well as a few conventions one should be aware of
 before making changes to the doc.
 
 The crux of the documentation is written in
-[reStructuredText](http://docutils.sourceforge.net/rst.html) which is
-converted to HTML using [Sphinx](http://www.sphinx-doc.org/en/stable/).
-The HTML is then published on http://hyperledger-fabric.readthedocs.io
+`reStructuredText <http://docutils.sourceforge.net/rst.html>`__ which is
+converted to HTML using `Sphinx <http://www.sphinx-doc.org/en/stable>`__.
+The HTML is then published on http://blockchain-explorer.readthedocs.io
 which has a hook so that any new content that goes into `docs/source`
 on the main repository will trigger a new build and publication of the
 doc.
 
-## Conventions
+Conventions
+~~~~~~~~~~~
 
 * Source files are in RST format and found in the `docs/source` directory.
 * The main entry point is index.rst, so to add something into the Table
@@ -42,15 +46,17 @@ Notes: The above means we have a dependency on the github mirror
 repository. Relative links are unfortunately not working on github
 when browsing through a RST file.
 
-## Setup
+Setup
+~~~~~
 
 Making any changes to the documentation will require you to test your
 changes by building the doc in a way similar to how it is done for
 production. There are two possible setups you can use to do so:
 setting up your own staging repo and publication website, or building
 the docs on your machine. The following sections cover both options:
 
-### Building the docs on your machine
+Building the docs on your machine
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Here are the quick steps to achieve this on a local machine without
 depending on ReadTheDocs, starting from the main fabric
@@ -95,4 +101,4 @@ You can then access the html files at `http://localhost/index.html`.
 
 
 .. Licensed under Creative Commons Attribution 4.0 International License
-   https://creativecommons.org/licenses/by/4.0/
+   https://creativecommons.org/licenses/by/4.0/-~~~~~~
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/source/.DS_Store b/docs/source/.DS_Store
diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst
@@ -118,9 +118,20 @@ Submitting your change request
 Copyright Notices
 
 There should be a single LICENSE file in the top-level directory that contains the full text of the Apache License `here <http://www.apache.org/licenses/LICENSE-2.0>`__.
-In the individual files, please use the following line:
 
-SPDX-License-Identifier: Apache-2.0
+
+
+
+
+.. note:: In the individual files, please use the following line:
+
+
+          ::
+
+														/*
+														   SPDX-License-Identifier: Apache-2.0
+														*/
+
 
 
 Related Topics

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,26 +3,44 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+
+Hyperledger Explorer documentation
+**********************************
+
 .. image:: images/Hyperledger_Explorer_Logo_Color.png
 
-Let's start, this is the documentation for the HL Explorer
 
 
-.. toctree::
-   :maxdepth: 1
 
-   introduction
-   CONTRIBUTING
 
+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.
 
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Table of contents
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+
+   introduction
+   CONTRIBUTING
+
 
 
 .. Licensed under Creative Commons Attribution 4.0 International License

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -1,6 +1,6 @@
-# Introduction
 
-## Hyperledger Explorer Tutorial
+Hyperledger Explorer Tutorial
+-----------------------------
 
 TODO
 ~~~~
@@ -20,4 +20,3 @@ List
    https://creativecommons.org/licenses/by/4.0/
 
 
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,3 +31,4 @@ ssl-certs/*.csr
		0
		app/test/.nyc_output/
		docs/build/
		*.DS_Store