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.

Sign up for GitHub

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

Jump to bottom

R4R: Update cli docs #2076

Merged
merged 4 commits into from
Aug 17, 2018
Merged

R4R: Update cli docs #2076

merged 4 commits into from
Aug 17, 2018

Conversation

fedekunze
Copy link
Collaborator

@fedekunze fedekunze commented Aug 17, 2018 •
edited
Loading

Closes #2026

  • Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
  • Updated all relevant documentation (docs/)
  • Updated all relevant code comments
  • Wrote tests
  • Added entries in PENDING.md that include links to the relevant issue or PR that most accurately describes the change.
  • Updated cmd/gaia and examples/

For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@fedekunze fedekunze added T:Docs Changes and features related to documentation. C:CLI ready-for-review labels Aug 17, 2018
@fedekunze fedekunze mentioned this pull request Aug 17, 2018
Closed
9 tasks
cwgoes
cwgoes previously requested changes Aug 17, 2018
View reviewed changes
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

See comments

docs/sdk/clients.md Outdated

```bash
gaiacli stake unbond begin \
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

Accidental?

docs/sdk/clients.md Outdated

```bash
gaiacli stake validators \
--chain-id=gaia-8000
Copy link
Contributor

Choose a reason for hiding this comment

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

Not necessary

docs/sdk/clients.md Outdated

```bash
gaiacli stake validator <account_cosmosaccaddr> \
--chain-id=gaia-8000
Copy link
Contributor

Choose a reason for hiding this comment

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

Not necessary

docs/sdk/clients.md Outdated

```bash
gaiacli stake delegate \
--amount=10steak \
--address-validator=$(gaiad tendermint show_validator) \
--name=<key_name> \
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

Accidental?

docs/sdk/clients.md Outdated
gaiacli stake delegation \
--address-delegator=<account_cosmosaccaddr> \
--address-validator=$(gaiad tendermint show-validator) \
--chain-id=gaia-8000
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think you need --chain-id on any query commands (double-check)

docs/sdk/clients.md Outdated

<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

Accidental?

docs/validators/validator-setup.md Outdated
```bash
gaiacli stake signing-information <validator-pubkey>\
--chain-id=gaia-8000
>>>>>>> 1b16625e... Updated docs for clients
Copy link
Contributor

Choose a reason for hiding this comment

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

Accidental?

docs/validators/validator-setup.md Outdated
@@ -62,9 +62,36 @@ View the validator's information with this command:
```bash
gaiacli stake validator \
--address-validator=<account_cosmosaccaddr> \
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

Accidental?

@codecov
Copy link

codecov bot commented Aug 17, 2018 •
edited
Loading

Codecov Report

Merging #2076 into release/v0.24.0 will increase coverage by 0.24%.
The diff coverage is n/a.

@@                 Coverage Diff                 @@
##           release/v0.24.0    #2076      +/-   ##
===================================================
+ Coverage            63.73%   63.97%   +0.24%     
===================================================
  Files                  113      113              
  Lines                 6667     6665       -2     
===================================================
+ Hits                  4249     4264      +15     
+ Misses                2133     2118      -15     
+ Partials               285      283       -2

@fedekunze fedekunze requested a review from zmanian August 17, 2018 13:06
cwgoes
cwgoes reviewed Aug 17, 2018
View reviewed changes
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

LGTM as long as you've run through the commands

jackzampolin
jackzampolin approved these changes Aug 17, 2018
View reviewed changes
docs/sdk/clients.md Outdated
:::

### Send Tokens

```bash
gaiacli send \
--amount=10faucetToken \
--chain-id=gaia-7005 \
--chain-id=gaia-8000 \
Copy link
Member

Choose a reason for hiding this comment

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

I think we put this in as --chain-id=<chain-id>

docs/sdk/clients.md Outdated

```bash
gaiacli stake delegate \
--amount=10steak \
--address-validator=$(gaiad tendermint show_validator) \
--name=<key_name> \
--chain-id=gaia-7005
--chain-id=gaia-8000
Copy link
Member

@jackzampolin jackzampolin Aug 17, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

sed -i 's/gaia-7005/gaia-8000/g'

@fedekunze fedekunze changed the title Update cli docs, R4R: Update cli docs Aug 17, 2018
cwgoes
cwgoes approved these changes Aug 17, 2018
View reviewed changes
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

utACK

@cwgoes cwgoes merged commit 466e0c0 into release/v0.24.0 Aug 17, 2018
@cwgoes cwgoes deleted the fedekunze/2026-cli-docs branch August 17, 2018 16:50
@fedekunze fedekunze mentioned this pull request Aug 17, 2018
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwgoes cwgoes cwgoes approved these changes

@jackzampolin jackzampolin jackzampolin approved these changes

@zramsay zramsay Awaiting requested review from zramsay

@zmanian zmanian Awaiting requested review from zmanian

Assignees
No one assigned
Labels
C:CLI T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fedekunze @jackzampolin @cwgoes