diff --git a/docs/assets/a_plus_t.png b/docs/assets/a_plus_t.png deleted file mode 100644 index 8f5bc5e9..00000000 Binary files a/docs/assets/a_plus_t.png and /dev/null differ 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/assets/gce1.png b/docs/assets/gce1.png deleted file mode 100644 index 3bf3ad00..00000000 Binary files a/docs/assets/gce1.png and /dev/null differ diff --git a/docs/assets/gce2.png b/docs/assets/gce2.png deleted file mode 100644 index 358dcc04..00000000 Binary files a/docs/assets/gce2.png and /dev/null differ diff --git a/docs/assets/statefulset.png b/docs/assets/statefulset.png deleted file mode 100644 index ac68d22b..00000000 Binary files a/docs/assets/statefulset.png and /dev/null differ diff --git a/docs/assets/t_plus_k.png b/docs/assets/t_plus_k.png deleted file mode 100644 index bee9fe56..00000000 Binary files a/docs/assets/t_plus_k.png and /dev/null differ 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 dfb6e635..62739098 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,12 +171,29 @@ texinfo_documents = [ 'Database'), ] -os.mkdir('./tools') -urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/ansible/README.rst', filename='tools/ansible.rst') -urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/docker/README.rst', filename='tools/docker.rst') -urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/mintnet-kubernetes/README.rst', filename='tools/mintnet-kubernetes.rst') -urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/terraform-digitalocean/README.rst', filename='tools/terraform-digitalocean.rst') -urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/tm-bench/README.rst', filename='tools/benchmarking-and-monitoring.rst') +repo = "https://raw.githubusercontent.com/tendermint/tools/" +branch = "cleanup-and-move-docs" + +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/introduction.rst b/docs/introduction.rst index cc56b1bd..1a550737 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