R4R: Docs refactor #2794
Closed
R4R: Docs refactor #2794
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zramsay
requested review from
cwgoes,
ebuchman and
rigelrozanski
as code owners
Codecov Report
@@ Coverage Diff @@
## develop #2794 +/- ##
===========================================
- Coverage 56.67% 56.01% -0.67%
===========================================
Files 156 133 -23
Lines 9783 9223 -560
===========================================
- Hits 5545 5166 -379
+ Misses 3861 3709 -152
+ Partials 377 348 -29 |
Co-Authored-By: fedekunze <[email protected]>
Co-Authored-By: fedekunze <[email protected]>
zramsay
commented
Nov 13, 2018
|
|
||
| ## Application constructor | ||
|
|
||
| **File: [`app/app.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/app/app.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Application codec | ||
|
|
||
| **File: [`app/app.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/app/app.go)** |
zramsay
commented
Nov 13, 2018
| @@ -0,0 +1,56 @@ | |||
| # SDK By Examples - Simple Governance Application | |||
zramsay
commented
Nov 13, 2018
|
|
||
| - [Starting your own project](setup-and-design.md#get-started) | ||
| - [Setup](setup-and-design.md#setup) | ||
| - [Application design](setup-and-design.md#application-design) |
There was a problem hiding this comment.
all the above, prefix with ./
zramsay
commented
Nov 13, 2018
|
|
||
| ### Implementation of the application | ||
|
|
||
| **Important note: All the code for this application can be found [here](https://github.com/cosmos/cosmos-sdk/tree/fedekunze/module_tutorial/examples/simpleGov). Snippets will be provided throughout the tutorial, but please refer to the provided link for the full implementation details** |
zramsay
commented
Nov 13, 2018
|
|
||
| ### Rest server | ||
|
|
||
| **File: [`cmd/simplegovd/main.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/cmd/simplegovd/main.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Makefile | ||
|
|
||
| The [Makefile](https://en.wikipedia.org/wiki/Makefile) compiles the Go program by defining a set of rules with targets and recipes. We'll need to add our application commands to it: |
There was a problem hiding this comment.
lol, link to our own makefile?
zramsay
commented
Nov 13, 2018
| - [Running the application](running-the-application.md) | ||
| + [Installation](running-the-application.md#installation) | ||
| + [Submit a proposal](running-the-application.md#submit-a-proposal) | ||
| + [Cast a vote](running-the-application.md#cast-a-vote) |
zramsay
commented
Nov 13, 2018
|
|
||
| ### Setup work environment | ||
|
|
||
| Go to the [Cosmos-SDK repo](https://githum.com/cosmos/cosmos-sdk) and fork it. Then open a terminal and: |
There was a problem hiding this comment.
trying to compile a fork in golang won't work because paths
There was a problem hiding this comment.
also, github, not githum
zramsay
commented
Nov 13, 2018
|
|
||
| For this tutorial, we will code a **simple governance application**, accompagnied by a **simple governance module**. It will allow us to explain most of the basic notions required to build a functioning application on the Cosmos-SDK. Note that this is not the governance module used for the Cosmos Hub. A much more [advanced governance module](https://github.com/cosmos/cosmos-sdk/tree/develop/x/gov) will be used instead. | ||
|
|
||
| All the code for the `simple_governance` application can be found [here](https://github.com/gamarin2/cosmos-sdk/tree/module_tutorial/examples/simpleGov/x/simple_governance). You'll notice that the module and app aren't located at the root level of the repo but in the examples directory. This is just for convenience, you can code your module and application directly in the root directory. |
zramsay
commented
Nov 13, 2018
|
|
||
| In terms of store, we will just create one [KVStore](#kvstore) in the multistore to store `Proposals`. We will also store the `Vote` (`Yes`, `No` or `Abstain`) chosen by each voter on each proposal. | ||
|
|
||
|
|
zramsay
commented
Nov 13, 2018
|
|
||
| ## Types | ||
|
|
||
| **File: [`x/simple_governance/types.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/types.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Keeper | ||
|
|
||
| **File: [`x/simple_governance/keeper.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/keeper.go)** |
zramsay
commented
Nov 13, 2018
| ```go | ||
| // in app.go | ||
|
|
||
| // instanciate keepers |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Handler | ||
|
|
||
| **File: [`x/simple_governance/handler.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/handler.go)** |
zramsay
commented
Nov 13, 2018
| func NewKeeper(SimpleGov sdk.StoreKey, ck bank.Keeper, sm stake.Keeper, codespace sdk.CodespaceType) Keeper | ||
| ``` | ||
|
|
||
| This function is called from the main [`app.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/app/app.go) file to instanciate a new `Keeper`. A similar function exits for `KeeperRead`. |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Codec | ||
|
|
||
| **File: [`x/simple_governance/codec.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/codec.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Errors | ||
|
|
||
| **File: [`x/simple_governance/errors.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/errors.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Command-Line Interface | ||
|
|
||
| **File: [`x/simple_governance/client/cli/simple_governance.go`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/client/cli/simple_governance.go)** |
zramsay
commented
Nov 13, 2018
|
|
||
| ## Rest API | ||
|
|
||
| **File: [`x/simple_governance/client/rest/simple_governance.goo`](https://github.com/cosmos/cosmos-sdk/blob/fedekunze/module_tutorial/examples/simpleGov/x/simple_governance/client/rest/simple_governance.go)** |
zramsay
commented
Nov 13, 2018
| 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 [Cosmos SDK](/getting-started/installation.md) installed. If you ran a full node on a previous testnet, please skip to [Upgrading From Previous Testnet](#upgrading-from-previous-testnet). | ||
| **Please ensure you have the [gaia binaries](.//installation.md) installed.** |
zramsay
commented
Nov 13, 2018
| @@ -44,14 +44,18 @@ __Note__: When specifying commission parameters, the `commission-max-change-rate | |||
| is used to measure % _point_ change over the `commission-rate`. E.g. 1% to 2% is | |||
| a 100% rate increase, but only 1 percentage point. | |||
|
|
|||
| ::: tip | |||
| Use `gaiacli tx stake create-validator -h` to get a list of all the available flags. | |||
| ::: | |||
There was a problem hiding this comment.
this is really a generic tip to use -h which is true of basically any cli
zramsay
commented
Nov 13, 2018
| @@ -0,0 +1,240 @@ | |||
| # Cosmos SDK Overview | |||
There was a problem hiding this comment.
i thought this file was moved? is it meant to be the README?
zramsay
commented
Nov 13, 2018
| @@ -1,28 +1,31 @@ | |||
| # Cosmos Hub Spec | |||
| # Specifications | |||
zramsay
commented
Nov 13, 2018
|
|
||
| This directory contains specifications for the state transition machine of the | ||
| Cosmos Hub. | ||
| This directory contains specifications for the modules of the Cosmos SDK as well as Interchain Standards (ICS) and other specifications.. |
|
PR without merge conflicts: #2808 |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #2697
Summary of Changes:
complete re-organization & slimming down of the
docs/directoryvarious documentation updates & improvements / fixes
update landing page & sidebar
Add docs architecture ADR
Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
Wrote tests
Updated relevant documentation (
docs/)Added entries in
PENDING.mdwith issue #rereviewed
Files changedin the github PR explorerFor Admin Use: