docs: pull in staking docs from gaia #273
Conversation
|
lol nice commit messages |
|
@zramsay is it possible to organize these rst files a bit? This folder is just kind of a huge dump right now... I'd like to be able to open a folder and see everything relevant to gaia |
|
good call. i was waiting for it grow & now we're at that point |
There was a problem hiding this comment.
Content looks good so-far, I'll go through actually running it later...... couple general comments:
- we should use more word wrap, in vim I set my word wrap to I think about 80 characters... some of the old tutorial content still has the word wrap, but the new stuff doesn't.. this is obviously just for development.
- the process flow between these 3 files is a bit confusing. There are kind of 2 end points here, we should maybe cleanup the tutorial flow a bit.
docs/staking-module.rst
Outdated
| Using Gaia | ||
| ========== | ||
|
|
||
| The purpose of the ``gaia`` staking module is to provide users with the ability to 1) declare candidacy as a validator, 2) bond/unbond to a candidate. |
There was a problem hiding this comment.
if you're going to use numbers maybe make it a list? looks a bit weird - or use closed brackets maybe (1). Also let's add a slightly longer intro here.. I like what is in the https://github.com/cosmos/gaia/blob/develop/README.md
docs/staking-module.rst
Outdated
|
|
||
| The purpose of the ``gaia`` staking module is to provide users with the ability to 1) declare candidacy as a validator, 2) bond/unbond to a candidate. | ||
|
|
||
| For the time being, the ``gaia`` tooling is installed seperately from the Cosmos-SDK: |
There was a problem hiding this comment.
For the time being? gaia just builds off of SDK and is precursor mainnet (and mainnet testnet) so it will always be installed separately from the SDK... however, the staking module will sooner or later find its way into the SDK
docs/staking-module.rst
Outdated
|
|
||
| :: | ||
|
|
||
| gaia client query candidate --pubkey=<pub_key data> |
There was a problem hiding this comment.
We should also show how to use the gaia client query delegator-bond function so users can see the bond
docs/staking-module.rst
Outdated
| :: | ||
|
|
||
| gaia client tx unbond --amount=5fermion --name=charlie --pubkey=<pub_key data> | ||
| gaia client query account 48F74F48281C89E5E4BE9092F735EA519768E8EF |
There was a problem hiding this comment.
use the gaia client query delegator-bond as well here
docs/staking-module.rst
Outdated
|
|
||
| :: | ||
|
|
||
| gaia client tx send --amount=999fermion --sequence=2 --name=alice --to=48F74F48281C89E5E4BE9092F735EA519768E8EF |
There was a problem hiding this comment.
can we use even numbers here? like 1000
docs/staking-module.rst
Outdated
|
|
||
| :: | ||
|
|
||
| gaia client tx send --amount=992fermion --sequence=1 --name=alice --to=5A35E4CC7B7DC0A5CB49CEA91763213A9AE92AD6 |
There was a problem hiding this comment.
Let's use even numbers here like 1000
docs/local-testnet.rst
Outdated
| Local Testnet | ||
| ============= | ||
|
|
||
| This tutorial demonstrates the basics of setting up a gaia |
There was a problem hiding this comment.
Can we add a comment as to the first tutorial in staking-module.rst - we should position the reader in each tutorial... unless that is already kind of implied via the UX of readthedocs?
There was a problem hiding this comment.
yeah, it's implied in the UX but I'll add some links where appropriate.
docs/atlas-testnet.rst
Outdated
|
|
||
| Atlas is a community testnet which can be used to test setting up a | ||
| cosmos validator node. In addition to this tutorial you can also | ||
| follow `this video <https://www.youtube.com/watch?v=B-shjoqvnnY>`__. |
There was a problem hiding this comment.
Is this video still relevant? Maybe remove for now?
docs/atlas-testnet.rst
Outdated
|
|
||
| :: | ||
|
|
||
| gaia client keys new bob |
There was a problem hiding this comment.
Should maybe just link to the first tutorial page to make the keys? shouldn't explain how to make the keys in a billion places
zramsay
changed the title
|
comments addressed |
| "height": 2963 | ||
| } | ||
|
|
||
| Check out ``bob``'s account, which should now have 992 fermions: |
There was a problem hiding this comment.
"should now have 1000 fermions"
There was a problem hiding this comment.
or rather 7 tokens if we scale down the tutorial
There was a problem hiding this comment.
i'll just add a note that the tokens are arbitrary in the tut
docs/staking/intro.rst
Outdated
|
|
||
| The first thing you'll want to do is either `create a local testnet <./local-testnet.html>`__ or | ||
| join a `public testnet <./public-testnet.html>`__. Either step is required before proceeding | ||
| (although you should browse below and make some keys first). |
There was a problem hiding this comment.
This whole paragraph is really confusing, the first thing you want to do is generate keys... I would change this paragraph to something along the lines:
Before proceeding with the tutorials you will need to:
- set up some [keys](link to the generating keys sections )
- Either
-create a local testnet <./local-testnet.html>- or, join a
public testnet <./public-testnet.html>
Afterwords you may proceed with testing out the functionality.
- or, join a
docs/staking/intro.rst
Outdated
| join a `public testnet <./public-testnet.html>`__. Either step is required before proceeding | ||
| (although you should browse below and make some keys first). | ||
|
|
||
| Install |
There was a problem hiding this comment.
Shouldn't install come before setup testnet?
|
|
||
| :: | ||
|
|
||
| gaia client tx send --amount=1000fermion --sequence=1 --name=alice --to=5A35E4CC7B7DC0A5CB49CEA91763213A9AE92AD6 |
There was a problem hiding this comment.
Sorry just realized that if you get tokens from the faucet you only receive 10 https://www.cosmosvalidators.com/
As such we should really make the tutorial revolve around that - maybe scale everything down to 7 tokens (and give it a whirl to make sure then math adds up)
|
@zramsay looks good, just a few more comments to address and I think we're good to merge |
zramsay
force-pushed
the
staking-docs
branch
from
1e99977 to
2d5ea64
Compare
It looks like some commands were deprecated. I am not sure but old versions are broken anymore.
* Rebuild PDF * Separate commitment path (ref cosmos#258) * Clarify connection versioning (ref cosmos#269) * Note private store key flexibility (ref cosmos#145)
moves docs from cosmos/gaia#48