From 0061fa0b47a03668148324ca42a27088795287e2 Mon Sep 17 00:00:00 2001 From: nfrunza Date: Thu, 11 Jul 2019 14:03:38 -0400 Subject: [PATCH] BE-678 Create online documentation * Link updates, and docs Signed-off-by: nfrunza Change-Id: I2e43f251fab53dc7c0672d94e2a1e38cf67dd22a --- .gitignore | 1 + docs/README.rst | 32 +++++++++++++++++------------ docs/index.rst | 29 -------------------------- docs/source/.DS_Store | Bin 6148 -> 0 bytes docs/source/CONTRIBUTING.rst | 15 ++++++++++++-- docs/source/index.rst | 38 ++++++++++++++++++++++++++--------- docs/source/introduction.rst | 5 ++--- 7 files changed, 63 insertions(+), 57 deletions(-) delete mode 100644 docs/index.rst delete mode 100644 docs/source/.DS_Store diff --git a/.gitignore b/.gitignore index ed0d74121..93477968d 100644 --- 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 index 8195bdb86..b31da970d 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,30 +1,34 @@ - -## Hyperledger Explorer +Hyperledger Explorer +==================== -- [Project Lifecycle](project_lifecycle/README.md) -- [Hyperledger Explorer functionalities](project_functionalities/README.md) +`Project Lifecycle `__ +`Hyperledger Explorer functionalities `__ -# 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 `__ which is +converted to HTML using `Sphinx `__. +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,7 +46,8 @@ 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 @@ -50,7 +55,8 @@ 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 deleted file mode 100644 index bbc48ee17..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. Hyperledger Explorer documentation master file, created by - sphinx-quickstart on Tue Jul 2 15:36:38 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: images/Hyperledger_Explorer_Logo_Color.png - -Let's start, this is the documentation for the HL Explorer - - -.. toctree:: - :maxdepth: 1 - - source/introduction - source/CONTRIBUTING - - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - -.. Licensed under Creative Commons Attribution 4.0 International License - https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/.DS_Store b/docs/source/.DS_Store deleted file mode 100644 index 1db112810dd1303148bc945dea8845c4bd1d30cd..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKJ8DBg43rWR3~5}Z+$-b;i*Zhn3*=)b1RPwL^sn-{aQ-P+&lZSZ+o>* z`^QJY@x})#voJSgQa}nw0VyB_q`oP z6p#XA1#WY>VE=!DpLqX|Nm@w(DR5N^_-ysOTH;F8TPK%euWj%bICFmCG|Yp7A=)u8 i+A$Vv#}AQ|d5v@I_rf7D=!gd$sGkAqB9j7_R^ShO>l;!4 diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst index 655d5bf67..a73cf3572 100644 --- 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 `__. -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 index 55d7cc5d0..4911907e5 100644 --- 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 index d5e194f45..92076a56d 100644 --- 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/ -