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

docs: Add new section "Running a Node" #7701

Merged
merged 21 commits into from
Nov 4, 2020
Merged

docs: Add new section "Running a Node" #7701

merged 21 commits into from
Nov 4, 2020

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Oct 28, 2020

Description

ref: #7657
ref: #7403

rendered

  • Move interfaces/keyring.md to run-node/keyring.md, and update content.
  • Move using-the-sdk/quickstart.md to run-node/run-node.md and run-node/interact-node.md, and update content.

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • 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.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@amaury1093 amaury1093 added backport/0.40.x (Stargate) T:Docs Changes and features related to documentation. labels Oct 28, 2020
@amaury1093 amaury1093 marked this pull request as ready for review November 3, 2020 15:37
Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

Left few comments and suggestions.

docs/run-node/interact-node.md Outdated Show resolved Hide resolved
docs/run-node/interact-node.md Outdated Show resolved Hide resolved
docs/run-node/interact-node.md Outdated Show resolved Hide resolved
docs/run-node/interact-node.md Outdated Show resolved Hide resolved
docs/run-node/interact-node.md Outdated Show resolved Hide resolved
docs/run-node/keyring.md Outdated Show resolved Hide resolved
docs/run-node/run-node.md Outdated Show resolved Hide resolved
docs/run-node/run-node.md Outdated Show resolved Hide resolved
docs/run-node/run-node.md Show resolved Hide resolved
docs/run-node/keyring.md Outdated Show resolved Hide resolved
Copy link
Contributor

@clevinson clevinson left a comment

Choose a reason for hiding this comment

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

Few minor comments, but otherwise lgtm!

docs/run-node/keyring.md Outdated Show resolved Hide resolved
docs/run-node/keyring.md Outdated Show resolved Hide resolved
docs/run-node/keyring.md Outdated Show resolved Hide resolved
docs/run-node/keyring.md Outdated Show resolved Hide resolved
docs/run-node/run-node.md Outdated Show resolved Hide resolved
docs/run-node/run-node.md Outdated Show resolved Hide resolved
@amaury1093 amaury1093 marked this pull request as draft November 4, 2020 09:54
@codecov
Copy link

codecov bot commented Nov 4, 2020

Codecov Report

Merging #7701 into master will increase coverage by 0.02%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##           master    #7701      +/-   ##
==========================================
+ Coverage   54.19%   54.21%   +0.02%     
==========================================
  Files         610      609       -1     
  Lines       38872    38872              
==========================================
+ Hits        21065    21076      +11     
+ Misses      15650    15638      -12     
- Partials     2157     2158       +1     

docs/run-node/run-node.md Outdated Show resolved Hide resolved
@amaury1093
Copy link
Contributor Author

Thanks a bunch @robert-zaremba @alessio @clevinson for this review, it was very helpful! I believe I addressed all comments, would appreciate another round of review.

@amaury1093 amaury1093 marked this pull request as ready for review November 4, 2020 11:20
@alessio alessio added the A:automerge Automatically merge PR once all prerequisites pass. label Nov 4, 2020
@mergify mergify bot merged commit 71166c8 into master Nov 4, 2020
@mergify mergify bot deleted the am-7657-run-node branch November 4, 2020 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants