Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

R4R: Docs refactor #2794

Closed
wants to merge 62 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
399995b
Add commands for deposits and fix links
Oct 30, 2018
47eeb7d
fix config
Oct 30, 2018
28d1adb
Changelog
Oct 30, 2018
f7c6048
Add tally cmd
Oct 30, 2018
1eb005e
typo
Oct 30, 2018
33bcfee
cosmos-sdk-cli
Oct 30, 2018
0a0e155
Update warning
Oct 30, 2018
9ff3d4b
Update docs/sdk/clients.md
alexanderbez Nov 1, 2018
4a1f6a4
Address comments
Nov 1, 2018
e574b50
Address Gautier's comments
Nov 2, 2018
a00e8a2
Update docs/sdk/clients.md
gamarin2 Nov 2, 2018
4f72113
organize ADR directory like tendermint
zramsay Nov 5, 2018
6db3dcb
better adr template
zramsay Nov 5, 2018
c501b13
docs: move spec-proposals into spec/
zramsay Nov 5, 2018
ef3feba
remove lotion, moved to website repo
zramsay Nov 5, 2018
d947240
move getting-started to cosmos-hub, and voyager to website
zramsay Nov 5, 2018
8dd7f3f
docs: move lite/ into clients/lite/
zramsay Nov 5, 2018
18c5d29
a single image doesn't require a dir
zramsay Nov 5, 2018
e666fd9
move introduction/ content to website repo
zramsay Nov 5, 2018
e6549ca
move resources/ content to website repo
zramsay Nov 5, 2018
0800f4e
mv sdk/clients.md to clients/clients.md
zramsay Nov 5, 2018
47e2be1
mv validators to cosmos-hub/validators
zramsay Nov 5, 2018
d4db10e
move deprecated sdk/ content to _attic
zramsay Nov 5, 2018
2afb33b
consolidate remianing sdk/ files into a single sdk.md
zramsay Nov 5, 2018
bc777ee
move examples/ to docs/examples/
zramsay Nov 5, 2018
b2ed220
mv docs/cosmos-hub to docs/gaia
zramsay Nov 5, 2018
a8ba0cd
Add keys/accounts section to localnet docs
Nov 6, 2018
9ce4863
Remove extra home flag
Nov 6, 2018
5793ac6
Minor update
Nov 6, 2018
deb0798
address @cwgoes comments
Nov 6, 2018
02bf94a
changes to struct
gamarin2 Nov 6, 2018
e2c6604
Clarify key usage
Nov 6, 2018
368b783
mv architecture to root of docs dir
zramsay Nov 6, 2018
2e00686
revert #2705
zramsay Nov 6, 2018
62eb748
Update seed location path
Nov 7, 2018
ba09afa
Makefile: install examples
zramsay Nov 8, 2018
54ef533
update config.js
zramsay Nov 8, 2018
511b8fd
paths
zramsay Nov 9, 2018
2b6001d
update readme
gamarin2 Nov 6, 2018
42b5ee8
small fix
gamarin2 Nov 7, 2018
97a054e
add gaia README
gamarin2 Nov 7, 2018
9d7c4bf
refine docs readme
gamarin2 Nov 7, 2018
f048680
little fix
gamarin2 Nov 7, 2018
1b75680
workin on cleanup
gamarin2 Nov 9, 2018
c84c3f2
^^
gamarin2 Nov 9, 2018
e116019
cleanup specs
gamarin2 Nov 9, 2018
49c5826
keep cleanup
gamarin2 Nov 9, 2018
3c39fa7
sdk intro 1/2
gamarin2 Nov 12, 2018
90b7c16
fix link
gamarin2 Nov 12, 2018
a817adc
fix link bis
gamarin2 Nov 12, 2018
1a88cff
update README
gamarin2 Nov 12, 2018
bf63824
better sdk overview 2/2
gamarin2 Nov 12, 2018
5a671e7
Update docs to reflect changes from #2728
jackzampolin Nov 12, 2018
ba6f65e
Address PR comments
jackzampolin Nov 13, 2018
d44c29f
link fix
gamarin2 Nov 13, 2018
e5ddf22
get dem tests passing
zramsay Nov 13, 2018
ba61b72
Add adr-002
gamarin2 Nov 5, 2018
a3e4134
.
gamarin2 Nov 5, 2018
4c1c670
add adr to new org
gamarin2 Nov 5, 2018
818281b
fix typo
gamarin2 Nov 5, 2018
9a3cab9
integrate zach review
gamarin2 Nov 5, 2018
2ac7547
little ficx
gamarin2 Nov 5, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address PR comments
  • Loading branch information
jackzampolin authored and zramsay committed Nov 13, 2018
commit ba6f65e91fca045ec46b159559864d99fbe7eb7d
7 changes: 1 addition & 6 deletions docs/DOCS_README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
## Updating the docs

If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in `/docs`.

- If your change relates to the core SDK (`baseapp`, `store`, ...), please update the `docs/gaia` folder, the `docs/examples` folder and possibly the `docs/spec` folder.
- If your changes relate specifically to the `gaia` application (not including modules), please modify the `docs/gaia` folder.
- If your changes relate to a module, please update the module's spec in `docs/spec`. If the module is used by `gaia` and/or `basecoin`, you might also need to modify `docs/gaia` and/or `docs/examples`.
- If your changes relate to the core of the CLI or Light-client (not specifically to module's CLI/Rest), please modify the `docs/clients` folder.
If you want to open a PR on the Cosmos SDK to update the documentation, please follow the guidelines in the [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md)

## Docs Build Workflow
Copy link
Contributor Author

@zramsay zramsay Nov 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be H1 and Updating the Docs can be H2 and the rest of the headers can stay H2/H3


Expand Down
14 changes: 6 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ Welcome to the SDK docs!

### SDK Intro

If you are a newcomer and would like to learn more about the Cosmos SDK, this **[intro](./sdk.md)** is a good starting place.
If you are a newcomer and would like to learn more about the Cosmos SDK, this **[intro](./intro/README.md)** is a good starting place.

### SDK tutorial

If you like to learn by doing, you can follow the **[SDK application tutorial](https://github.com/cosmos/sdk-application-tutorial)**. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process.
If you like to learn by doing, you can follow the **[SDK application tutorial](https://github.com/cosmos/sdk-application-tutorial)**. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process.

## Use the SDK

The following sections contain the information you need if you want to build a fully-fonctional SDK-based blockchain:
The following sections contain the information you need if you want to build a fully-functional SDK-based blockchain:

>*NOTE*: We are currently working on improving the docs. Some info might be missing.
>*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).
- [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).
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

Expand All @@ -36,5 +36,3 @@ To install the latest version of the `gaia` application and join the public test

See [this file](./DOCS_README.md) for details of the build process and
considerations when making changes.


6 changes: 3 additions & 3 deletions docs/gaia/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 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).

Expand All @@ -20,7 +20,7 @@ echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile
## Install Cosmos SDK

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
If necessary, make sure you `git checkout` the correct
[released version](https://github.com/cosmos/cosmos-sdk/releases).

```bash
Expand All @@ -31,7 +31,7 @@ cd cosmos-sdk && git checkout master
make get_tools && make get_vendor_deps && make install
```

> *NOTE*: If you have issues at this step, please check that you have the latest stable version of GO installed.
> *NOTE*: If you have issues at this step, please check that you have the latest stable version of GO installed.

That will install the `gaiad` and `gaiacli` binaries. Verify that everything is OK:

Expand Down
27 changes: 11 additions & 16 deletions docs/gaia/join-testnet.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Join the Testnet

::: tip Current Testnet
See the [testnet repo](https://github.com/cosmos/testnets) for
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](/getting-started/installation.md) installed.**
**Please ensure you have the [gaia binaries](/gaia/installation.md) installed.**

If you ran a full node on a previous testnet, please skip to [Upgrading From Previous Testnet](#upgrading-from-previous-testnet).

## Setting Up a New Node

These instructions are for setting up a brand new full node from scratch.
These instructions are for setting up a brand new full node from scratch.

First, initialize the node and create the necessary config files:

```bash
gaiad init
gaiad init
```

::: warning Note
Expand Down Expand Up @@ -77,12 +77,12 @@ git fetch --all && git checkout master
make update_tools && make get_vendor_deps && make install
```

> *NOTE*: If you have issues at this step, please check that you have the latest stable version of GO installed.
> *NOTE*: If you have issues at this step, please check that you have the latest stable version of GO installed.

Note we use `master` here since it contains the latest stable release.
See the [testnet repo](https://github.com/cosmos/testnets)
for details on which version is needed for which testnet,
and the [SDK release page](https://github.com/cosmos/cosmos-sdk/releases)
See the [testnet repo](https://github.com/cosmos/testnets)
for details on which version is needed for which testnet,
and the [SDK release page](https://github.com/cosmos/cosmos-sdk/releases)
for details on each release.

Your full node has been cleanly upgraded!
Expand All @@ -98,19 +98,14 @@ 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.

### Add Seed Nodes

Your node needs to know how to find peers. You'll need to add healthy seed nodes to `$HOME/.gaiad/config/config.toml`. Here are some seed nodes you can use:
Your node needs to know how to find peers. You'll need to add healthy seed nodes to `$HOME/.gaiad/config/config.toml`. The `testnets` repo contains links to the seed nodes for each testnet. If you are looking to join the running testnet please [check the repository for details](https://github.com/cosmos/testnets) on which nodes to use.

```toml
# Comma separated list of seed nodes to connect to
seeds = "718145d422a823fd2a4e1e36e91b92bb0c4ddf8e@gaia-testnet.coinculture.net:26656,5922bf29b48a18c2300b85cc53f424fce23927ab@67.207.73.206:26656,7c8b8fd03577cd4817f5be1f03d506f879df98d8@gaia-7000-seed1.interblock.io:26656,a28737ff02391a6e00a1d3b79befd57e68e8264c@gaia-7000-seed2.interblock.io:26656,987ffd26640cd03d08ed7e53b24dfaa7956e612d@gaia-7000-seed3.interblock.io:26656"
```

If those seeds aren't working, you can find more seeds and persistent peers on the [Cosmos Explorer](https://explorecosmos.network/nodes). Open the the `Full Nodes` pane and select nodes that do not have private (`10.x.x.x`) or [local IP addresses](https://en.wikipedia.org/wiki/Private_network). The `Persistent Peer` field contains the connection string. For best results use 4-6.
If those seeds aren't working, you can find more seeds and persistent peers on the [Cosmos Explorer](https://explorer.cosmos.network/nodes). Open the the `Full Nodes` pane and select nodes that do not have private (`10.x.x.x`) or [local IP addresses](https://en.wikipedia.org/wiki/Private_network). The `Persistent Peer` field contains the connection string. For best results use 4-6.

You can also ask for peers on the [Validators Riot Room](https://riot.im/app/#/room/#cosmos-validators:matrix.org)

Expand Down
2 changes: 1 addition & 1 deletion docs/gaia/validators/validator-setup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Validator Setup

:::
The current testnet is `gaia-9001`.
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.
:::

Before setting up your validator node, make sure you've already gone through the [Full Node Setup](/docs/getting-started/full-node.md) guide.
Expand Down
7 changes: 3 additions & 4 deletions docs/spec/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Specifications
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop the plural


This directory contains specifications for the modules of the Cosmos SDK as well as Interchain Standards (ICS) and other specifications..
This directory contains specifications for the modules of the Cosmos SDK as well as Interchain Standards (ICS) and other specifications..
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

double period


SDK applications hold thri state in a Merkle store. Updates to
SDK applications hold this state in a Merkle store. Updates to
the store may be made during transactions and at the beginning and end of every
block.

Expand All @@ -25,8 +25,7 @@ block.
### Interchain standards

- [ICS30](./ics/ics-030-signed-messages.md) - Signed messages standard.
-
-

For details on the underlying blockchain and p2p protocols, see
the [Tendermint specification](https://github.com/tendermint/tendermint/tree/develop/docs/spec).