Improve testnet docs (cosmos#2928)

* improve testnet docs

README.md

@@ -19,12 +19,9 @@ breaking changes.
 
 **Note**: Requires [Go 1.11+](https://golang.org/dl/)
 
-## Gaia Testnet
+## Cosmos Hub Public Testnet
 
-To install the binaries, read the [install instructions](./docs/gaia/installation.md)
-
-To join the latest testnet, follow 
-[the guide](./docs/gaia/join-testnet.md).
+To run a full-node in the latest public testnet of the Hub, first [install `gaia`](./docs/gaia/installation.md), then follow [the guide](./docs/gaia/join-testnet.md).
 
 For status updates and genesis files, see the
 [testnets repo](https://github.com/cosmos/testnets).

docs/.vuepress/config.js

@@ -1,6 +1,6 @@
 module.exports = {
-  title: "Cosmos Documentation",
-  description: "Documentation for the Cosmos Network.",
+  title: "Cosmos SDK Documentation",
+  description: "Documentation for the Cosmos SDK and Gaia.",
   ga: "UA-51029217-2",
   dest: "./dist/docs",
   base: "/docs/",
@@ -30,13 +30,13 @@ module.exports = {
           "/gaia/validators/overview",
           "/gaia/validators/security",
           "/gaia/validators/validator-faq",
-          "/gaia/networks",
+          "/gaia/deploy-testnet",
           "/gaia/ledger",
           "/gaia/gaiacli"
         ]
       },
       {
-        title: "Clients",
+        title: "SDK Clients",
         collapsable: false,
         children: [
       	  "/clients/",

docs/README.md

@@ -22,15 +22,17 @@ The following sections contain the information you need if you want to build a f
 >*NOTE*: We are currently working on improving the docs. Some info might be missing. If that is the case, try the Cosmos [Forum](https://forum.cosmos.network). Failing that, [open an issue](https://github.com/cosmos/cosmos-sdk/issues/new).
 
 - [Introduction](./intro/README.md): Contains introductory high-level material on the Cosmos SDK.
-- [Gaia](./gaia/README.md): Contains all documentation related to the gaia application (current name for the Cosmos-Hub).
+- [Gaia](./gaia/README.md): Contains all documentation related to the gaia application (current name for the Cosmos-Hub). Also contains info on how to join gaia testnets.
 - [Clients](./clients/README.md): Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client.
 - [Specifications](./spec/README.md): Contains SDK and modules specifications.
 
 If you are reading this on the Cosmos Website, please know that you can find more information on [github](https://github.com/cosmos/cosmos-sdk/tree/develop/docs). Also if you find any issues with the documentation please [*open a Pull Request*](https://github.com/cosmos/cosmos-sdk/compare?expand=1), or at least [*open an Issue*](https://github.com/cosmos/cosmos-sdk/issues/new) to update the docs!
 
-## Join the public testnet for the Cosmos Hub
+## Cosmos Hub testnet
 
-To install the latest version of the `gaia` application and join the public testnet, **click [here](./gaia/README.md#join-the-cosmos-hub-public-testnet)**
+To install the latest version of the `gaia` application (application of the Cosmos Hub) and join the public testnet, **click [here](./gaia/join-testnet.md)**
+
+To start your own `gaia` testnet, **click [here](./gaia/deploy-testnet.md)**
 
 ## Contribute
 

docs/gaia/README.md

@@ -5,12 +5,12 @@ Welcome to the `Gaia` docs. `Gaia` is the current name of the Cosmos SDK applica
 ## Join the Cosmos Hub public testnet
 
 - [Install the `gaia` application](./installation.md)
-- [Join the current testnet](./join-testnet.md)
+- [Set up a full node and join the current public testnet](./join-testnet.md)
 - [Upgrade to a validator node](./validators/validator-setup.md)
 
 ## Setup your own `gaia` testnet
 
-- [Setup your own `gaia` testnet](./networks.md)
+- [Setup your own `gaia` testnet](./deploy-testnet.md)
 
 ## Additional resources
 

docs/gaia/networks.md → docs/gaia/deploy-testnet.md

@@ -1,4 +1,4 @@
-# Networks
+# Deploy your own testnet
 
 This document describes 3 ways to setup a network of `gaiad` nodes, each serving a different usecase:
 
@@ -73,7 +73,7 @@ make build-linux
 make build-docker-gaiadnode
 ```
 
-### Run a testnet
+### Run your testnet
 
 To start a 4 node testnet run:
 

docs/gaia/installation.md

@@ -1,8 +1,8 @@
-# Install Gaia
+## Install Gaia
 
 This guide will explain how to install the `gaiad` and `gaiacli` entrypoints onto your system. With these installed on a server, you can participate in the latest testnet as either a [Full Node](./join-testnet.md#run-a-full-node) or a [Validator](./validators/validator-setup.md).
 
-## Install Go
+### Install Go
 
 Install `go` by following the [official docs](https://golang.org/doc/install). Remember to set your `$GOPATH`, `$GOBIN`, and `$PATH` environment variables, for example:
 
@@ -17,7 +17,7 @@ echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile
 **Go 1.11+** is required for the Cosmos SDK.
 :::
 
-## Install Cosmos SDK
+### Install the binaries
 
 Next, let's install the latest version of Gaia. Here we'll use the `master` branch, which contains the latest stable release.
 If necessary, make sure you `git checkout` the correct
@@ -40,6 +40,6 @@ $ gaiad version
 $ gaiacli version
 ```
 
-## Run a Full Node
+### Next
 
-With the binaries installed, you can run [a full node on the latest testnet](./join-testnet.md).
+Now you can [join the public testnet](./join-testnet.md) or [create you own private testnet](./private-testnet.md)

docs/gaia/join-testnet.md

@@ -1,17 +1,19 @@
-# Join the Testnet
+# Join the latest public testnet
 
 ::: tip Current Testnet
 See the [testnet repo](https://github.com/cosmos/testnets) for
 information on the latest testnet, including the correct version
 of the Cosmos-SDK to use and details about the genesis file.
 :::
 
-**Please ensure you have the [gaia binaries](./installation.md) installed.**
-
-If you ran a full node on a previous testnet, please skip to [Upgrading From Previous Testnet](#upgrading-from-previous-testnet).
+::: warning
+**You need to [install gaia](./installation.md) before you go further**
+:::
 
 ## Setting Up a New Node
 
+> NOTE: If you ran a full node on a previous testnet, please skip to [Upgrading From Previous Testnet](#upgrading-from-previous-testnet).
+
 These instructions are for setting up a brand new full node from scratch.
 
 First, initialize the node and create the necessary config files:

docs/gaia/validators/validator-setup.md

@@ -1,9 +1,11 @@
-# Validator Setup
+# Run a validator on the gaia public testnet
 
 ::: tip
 Information on how to join the current testnet (`genesis.json` file and seeds) is held [in our `testnet` repo](https://github.com/cosmos/testnets/tree/master/latest). Please check there if you are looking to join our latest testnet. 
 :::
 
+__Note__: This documentation is only intended for validators of the **public testnet**
+
 Before setting up your validator node, make sure you've already gone through the [Full Node Setup](/docs/getting-started/full-node.md) guide.
 
 ## What is a Validator?
@@ -126,9 +128,10 @@ mkdir -p $HOME/.gaiad/config
 curl https://raw.githubusercontent.com/cosmos/testnets/master/latest/genesis.json > $HOME/.gaiad/config/genesis.json
 ```
 
-Note we use the `latest` directory in the [testnets repo](https://github.com/cosmos/testnets)
+__Note:__ We use the `latest` directory in the [testnets repo](https://github.com/cosmos/testnets)
 which contains details for the latest testnet. If you are connecting to a different testnet, ensure you get the right files.
 
+
 You also need to fetch the genesis transactions of all the other genesis validators. For now there is no repository where genesis transactions can be submitted by validators, but this will as soon as we try out this feature in a testnet.
 
 Once you've collected all genesis transactions in `~/.gaiad/config/gentx`, you can run:
@@ -137,6 +140,8 @@ Once you've collected all genesis transactions in `~/.gaiad/config/gentx`, you c
 gaiad collect-gentxs
 ```
 
+__Note:__ The accounts from which you delegate in the `gentx` transactions need to possess staking tokens in the genesis file, otherwise `collect-gentx` will fail.
+
 The previous command will collect all genesis transactions and finalise `genesis.json`. To verify the correctness of the configuration and start the node run:
 
 ```bash