From 35428ceb539af5deacd0ddaa7395f07c518a0e22 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 18 May 2018 10:01:56 -0400 Subject: [PATCH 1/2] docs: lil fixes --- docs/conf.py | 8 +------- docs/index.rst | 2 +- docs/transactional-semantics.rst | 6 +++--- 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8fefec4da..086173780 100644 --- a/docs/conf.py +++ b/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 ################################# diff --git a/docs/index.rst b/docs/index.rst index 99ca11e73..2bed07446 100644 --- a/docs/index.rst +++ b/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 `__. * There is also the `original whitepaper `__, though it is now quite outdated. diff --git a/docs/transactional-semantics.rst b/docs/transactional-semantics.rst index 268247a22..988ac682f 100644 --- a/docs/transactional-semantics.rst +++ b/docs/transactional-semantics.rst @@ -1,8 +1,8 @@ Transactional Semantics ======================= -In `"Using -Tendermint"<./specification/using-tendermint.html#broadcast-api>`__ we +In `Using +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`__), but +`GH#248 `__), but it's non-trivial to do this all efficiently. The temporary solution is for clients to monitor the node and resubmit From 0fb33ca91d13e448e7b0af36df0f2dd48c432b29 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Fri, 18 May 2018 10:12:52 -0400 Subject: [PATCH 2/2] docs: update install instructions, closes #1580 --- docs/install.rst | 59 ++++++++++++++++-------------------------------- 1 file changed, 20 insertions(+), 39 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index b2aae6766..3fc392a39 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -4,53 +4,48 @@ Install Tendermint From Binary ----------- -To download pre-built binaries, see the `Download page `__. +To download pre-built binaries, see the `releases page `__. From Source ----------- -You'll need ``go``, maybe `dep `__, and the Tendermint source code. - -Install Go -^^^^^^^^^^ - -Make sure you have `installed Go `__ and -set the ``GOPATH``. You should also put ``GOPATH/bin`` on your ``PATH``. +You'll need ``go`` `installed `__ and the required +`environment variables set `__ Get Source Code ^^^^^^^^^^^^^^^ -You should be able to install the latest with a simple - :: - 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. + mkdir -p $GOPATH/src/github.com/tendermint + cd $GOPATH/src/github.com/tendermint + git clone https://github.com/tendermint/tendermint.git + cd tendermint -First, install ``dep``: +Get Tools & Dependencies +^^^^^^^^^^^^^^^^^^^^^^^^ :: - 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 -still cloned to the correct location in the ``$GOPATH``. +to put the binary in ``$GOPATH/bin`` or use: + +:: + + make build -The latest Tendermint Core version is now installed. +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 ^^^