Update elections documentation#2563
Conversation
|
Currently based on the other branch of mine. Relevant changes are limited to |
Codecov Report
@@ Coverage Diff @@
## master #2563 +/- ##
=======================================
Coverage 93.63% 93.63%
=======================================
Files 45 45
Lines 2623 2623
=======================================
Hits 2456 2456
Misses 167 167 |
ttmc
left a comment
ttmc
left a comment
There was a problem hiding this comment.
I only reviewed the changes to the docs page about the BigchainDB CLI. Let me know if you want me to review other things as well.
| Election management is broken into several subcommands. Below is the command line syntax for each, | ||
| Election management is broken into several subcommands. Below is the command line syntax for each of them. | ||
|
|
||
| #### election new |
There was a problem hiding this comment.
This heading should have three ### in front of its name, because it's under a heading with two ##. Similar remarks can be made for other headings below; I will only comment on this one but please check them all.
| The election proposal consists of vote tokens allocated to every current validator proportional to his voting power. Validators spend their votes to approve the election using the [election-approve command](#election-approve). | ||
|
|
||
| There are multiple types of election, which each take different parameters. Below is a short description of each type of election, as well as their command line syntax and the return value. | ||
| Every election has a type. See below for how to create an election of a particular type. |
There was a problem hiding this comment.
Maybe we could list the two currently-supported types right here (i.e. 1) upsert-validator and 2) chain-migration), because below we don't actually use the word "type" when documenting the commands to create a new election of each type.
| ```bash | ||
| $ bigchaindb election new migration --private-key PATH_TO_YOUR_PRIVATE_KEY | ||
| [SUCCESS] Submitted proposal with id: <election_id> | ||
| $ bigchaindb election new chain-migration --private-key <path-to-theprivate-key> |
There was a problem hiding this comment.
Minor typo: theprivate-key> should be the-private-key>
| ``` | ||
|
|
||
| - `--private-key`: The path to Tendermint's private key which can be generally found at `/home/user/.tendermint/config/priv_validator.json`. | ||
| - `<path-to-the-private-key>` is the path to the private key of the validator who proposes the election. Tendemint places it at `.tendermint/config/priv_validator.json`. |
There was a problem hiding this comment.
Tendemint --> Tendermint, both here and elsewhere. (Do a search for "Tendemint".)
| Afterwards, validators are supposed to upgrade Tendermint, set new `chain_id`, `app_hash`, and `validators` (to learn these values, use the [election show](#election-show) command) in `genesis.json`, make and save a MongoDB dump, and restart the system. | ||
|
|
||
|
|
||
| For more details about how chain migrations work, refer to [BEP-42](https://github.com/bigchaindb/BEPs/tree/master/42). |
There was a problem hiding this comment.
Maybe we could be a bit more helpful and say "refer to Type 3 scenarios in BEP-42."
ldmberman
force-pushed
the
update-elections-documentation
branch
from
e96a20f to
64d4e67
Compare
| #### election new chain-migration | ||
|
|
||
| Create an election to halt block production, to allow for a version change across breaking changes. | ||
| Create an election to halt block production, to coordinate on making a Tendermint upgrade with a backwards-incompatible chain. |
There was a problem hiding this comment.
I would be good to bold backwards-incompatible chain
4 participants
No description provided.