Merge pull request #1591 from tendermint/zach/dawks

docs improvements

docs/conf.py

@@ -186,14 +186,8 @@ if os.path.isdir(assets_dir) != True:
 
 urllib.urlretrieve(tools_repo+tools_branch+'/docker/README.rst', filename=tools_dir+'/docker.rst')
 
-urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/README.rst', filename=tools_dir+'/mintnet-kubernetes.rst')
-urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/gce1.png', filename=assets_dir+'/gce1.png')
-urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/gce2.png', filename=assets_dir+'/gce2.png')
-urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/statefulset.png', filename=assets_dir+'/statefulset.png')
-urllib.urlretrieve(tools_repo+tools_branch+'/mintnet-kubernetes/assets/t_plus_k.png', filename=assets_dir+'/t_plus_k.png')
-
 urllib.urlretrieve(tools_repo+tools_branch+'/tm-bench/README.rst', filename=tools_dir+'/benchmarking.rst')
-urllib.urlretrieve('https://raw.githubusercontent.com/tendermint/tools/master/tm-monitor/README.rst', filename='tools/monitoring.rst')
+urllib.urlretrieve(tools_repo+tools_branch+'/tm-monitor/README.rst', filename='tools/monitoring.rst')
 
 #### abci spec #################################
 

docs/index.rst

@@ -42,7 +42,6 @@ Tendermint Tools
    deploy-testnets.rst
    terraform-and-ansible.rst
    tools/docker.rst
-   tools/mintnet-kubernetes.rst
    tools/benchmarking.rst
    tools/monitoring.rst
 
@@ -66,6 +65,7 @@ Tendermint 201
 
    specification.rst
    determinism.rst
+   transactional-semantics.rst
 
 * For a deeper dive, see `this thesis <https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769>`__.
 * There is also the `original whitepaper <https://tendermint.com/static/docs/tendermint.pdf>`__, though it is now quite outdated.

docs/install.rst

@@ -4,53 +4,48 @@ Install Tendermint
 From Binary
 -----------
 
-To download pre-built binaries, see the `Download page <https://tendermint.com/downloads>`__.
+To download pre-built binaries, see the `releases page <https://github.com/tendermint/tendermint/releases>`__.
 
 From Source
 -----------
 
-You'll need ``go``, maybe `dep <https://github.com/golang/dep>`__, and the Tendermint source code.
+You'll need ``go`` `installed <https://golang.org/doc/install>`__ and the required
-
+`environment variables set <https://github.com/tendermint/tendermint/wiki/Setting-GOPATH>`__
-Install Go
-^^^^^^^^^^
-
-Make sure you have `installed Go <https://golang.org/doc/install>`__ and
-set the ``GOPATH``. You should also put ``GOPATH/bin`` on your ``PATH``.
 
 Get Source Code
 ^^^^^^^^^^^^^^^
 
-You should be able to install the latest with a simple
+::
+
+    mkdir -p $GOPATH/src/github.com/tendermint
+    cd $GOPATH/src/github.com/tendermint
+    git clone https://github.com/tendermint/tendermint.git
+    cd tendermint
+
+Get Tools & Dependencies
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 ::
 
-    go get github.com/tendermint/tendermint/cmd/tendermint
-
-Run ``tendermint --help`` and ``tendermint version`` to ensure your
-installation worked.
-
-If the installation failed, a dependency may have been updated and become
-incompatible with the latest Tendermint master branch. We solve this
-using the ``dep`` tool for dependency management.
-
-First, install ``dep``:
-
-::
-
-    cd $GOPATH/src/github.com/tendermint/tendermint
     make get_tools
+    make get_vendor_deps
 
-Now we can fetch the correct versions of each dependency by running:
+Compile
+^^^^^^^
 
 ::
 
-    make get_vendor_deps
     make install
 
-Note that even though ``go get`` originally failed, the repository was
+to put the binary in ``$GOPATH/bin`` or use:
-still cloned to the correct location in the ``$GOPATH``.
 
-The latest Tendermint Core version is now installed.
+::
+
+    make build
+
+to put the binary in ``./build``.
+
+The latest ``tendermint version`` is now installed.
 
 Reinstall
 ---------
@@ -86,20 +81,6 @@ do, use ``dep``, as above:
 Since the third option just uses ``dep`` right away, it should always
 work.
 
-Troubleshooting
----------------
-
-If ``go get`` failing bothers you, fetch the code using ``git``:
-
-::
-
-    mkdir -p $GOPATH/src/github.com/tendermint
-    git clone https://github.com/tendermint/tendermint $GOPATH/src/github.com/tendermint/tendermint
-    cd $GOPATH/src/github.com/tendermint/tendermint
-    make get_tools
-    make get_vendor_deps
-    make install
-
 Run
 ^^^
 

docs/transactional-semantics.rst

@@ -1,8 +1,8 @@
 Transactional Semantics
 =======================
 
-In `"Using
+In `Using
-Tendermint"<./specification/using-tendermint.html#broadcast-api>`__ we
+Tendermint <./using-tendermint.html#broadcast-api>`__ we
 discussed different API endpoints for sending transactions and
 differences between them.
 
@@ -18,7 +18,7 @@ to peers the node crashes.
 
 We are planning to provide such guarantees by using a WAL and
 replaying transactions (See
-`GH#248<https://github.com/tendermint/tendermint/issues/248>`__), but
+`GH#248 <https://github.com/tendermint/tendermint/issues/248>`__), but
 it's non-trivial to do this all efficiently.
 
 The temporary solution is for clients to monitor the node and resubmit