diff --git a/CHANGELOG.md b/CHANGELOG.md index df01f87a1..d76fabfca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,7 +28,12 @@ BUG FIXES: - Graceful handling/recovery for apps that have non-determinism or fail to halt - Graceful handling/recovery for violations of safety, or liveness -## 0.10.4 (Septemeber 5, 2017) +## 0.11.0 (Date) + +IMPROVEMENTS: + - docs: Added documentation from the tools repo to Read The Docs pipeline + +## 0.10.4 (September 5, 2017) IMPROVEMENTS: - docs: Added Slate docs to each rpc function (see rpc/core) diff --git a/docs/abci-cli.rst b/docs/abci-cli.rst index 371ec0cba..5ca672c8a 100644 --- a/docs/abci-cli.rst +++ b/docs/abci-cli.rst @@ -1,5 +1,5 @@ -Using the abci-cli -================== +Using ABCI-CLI +============== To facilitate testing and debugging of ABCI servers and simple apps, we built a CLI, the ``abci-cli``, for sending ABCI messages from the diff --git a/docs/images/abci.png b/docs/assets/abci.png similarity index 100% rename from docs/images/abci.png rename to docs/assets/abci.png diff --git a/docs/images/consensus_logic.png b/docs/assets/consensus_logic.png similarity index 100% rename from docs/images/consensus_logic.png rename to docs/assets/consensus_logic.png diff --git a/docs/images/tm-transaction-flow.png b/docs/assets/tm-transaction-flow.png similarity index 100% rename from docs/images/tm-transaction-flow.png rename to docs/assets/tm-transaction-flow.png diff --git a/docs/conf.py b/docs/conf.py index 25a6bbf87..d5c49355f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,9 +16,10 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os +import os # import sys # sys.path.insert(0, os.path.abspath('.')) +import urllib import sphinx_rtd_theme @@ -169,3 +170,30 @@ texinfo_documents = [ author, 'Tendermint', 'Byzantine Fault Tolerant Consensus.', 'Database'), ] + +repo = "https://raw.githubusercontent.com/tendermint/tools/" +branch = "master" + +tools = "./tools" +assets = tools + "/assets" + +if os.path.isdir(tools) != True: + os.mkdir(tools) +if os.path.isdir(assets) != True: + os.mkdir(assets) + +urllib.urlretrieve(repo+branch+'/ansible/README.rst', filename=tools+'/ansible.rst') +urllib.urlretrieve(repo+branch+'/ansible/assets/a_plus_t.png', filename=assets+'/a_plus_t.png') + +urllib.urlretrieve(repo+branch+'/docker/README.rst', filename=tools+'/docker.rst') + +urllib.urlretrieve(repo+branch+'/mintnet-kubernetes/README.rst', filename=tools+'/mintnet-kubernetes.rst') +urllib.urlretrieve(repo+branch+'/mintnet-kubernetes/assets/gce1.png', filename=assets+'/gce1.png') +urllib.urlretrieve(repo+branch+'/mintnet-kubernetes/assets/gce2.png', filename=assets+'/gce2.png') +urllib.urlretrieve(repo+branch+'/mintnet-kubernetes/assets/statefulset.png', filename=assets+'/statefulset.png') +urllib.urlretrieve(repo+branch+'/mintnet-kubernetes/assets/t_plus_k.png', filename=assets+'/t_plus_k.png') + +urllib.urlretrieve(repo+branch+'/terraform-digitalocean/README.rst', filename=tools+'/terraform-digitalocean.rst') +urllib.urlretrieve(repo+branch+'/tm-bench/README.rst', filename=tools+'/benchmarking-and-monitoring.rst') +# the readme for below is included in tm-bench +# urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/tm-monitor/README.rst', filename='tools/tm-monitor.rst') diff --git a/docs/index.rst b/docs/index.rst index 18d83b4f0..ee1307bf2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,12 @@ Tendermint Tools :maxdepth: 2 deploy-testnets.rst + tools/ansible.rst + tools/docker.rst + tools/mintnet-kubernetes.rst + tools/terraform-digitalocean.rst + tools/benchmarking-and-monitoring.rst + Tendermint Ecosystem -------------------- diff --git a/docs/introduction.rst b/docs/introduction.rst index cfda74ed7..e37637ee7 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -156,7 +156,7 @@ There can be multiple ABCI socket connections to an application. Tendermint Core It's probably evident that applications designers need to very carefully design their message handlers to create a blockchain that does anything useful but this architecture provides a place to start. The diagram below illustrates the flow of messages via ABCI. -.. figure:: images/abci.png +.. figure:: assets/abci.png A Note on Determinism ~~~~~~~~~~~~~~~~~~~~~ @@ -180,7 +180,7 @@ Consensus Overview Tendermint is an easy-to-understand, mostly asynchronous, BFT consensus protocol. The protocol follows a simple state machine that looks like this: -.. figure:: images/consensus_logic.png +.. figure:: assets/consensus_logic.png Participants in the protocol are called "validators"; they take turns proposing blocks of transactions and voting on them. @@ -228,4 +228,4 @@ The `Cosmos Network `__ is designed to use this Proof-of- The following diagram is Tendermint in a (technical) nutshell. `See here for high resolution version `__. -.. figure:: images/tm-transaction-flow.png +.. figure:: assets/tm-transaction-flow.png