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/setup/deploying-a-runtime: example of registering a runtime #3100

Merged
merged 4 commits into from
Aug 21, 2020

Conversation

ptrus
Copy link
Member

@ptrus ptrus commented Jul 10, 2020

Fixes: #3081

TODO:

@codecov
Copy link

codecov bot commented Jul 10, 2020

Codecov Report

Merging #3100 into master will increase coverage by 0.21%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3100      +/-   ##
==========================================
+ Coverage   67.21%   67.42%   +0.21%     
==========================================
  Files         371      371              
  Lines       36107    36107              
==========================================
+ Hits        24270    24346      +76     
+ Misses       8683     8631      -52     
+ Partials     3154     3130      -24     
Impacted Files Coverage Δ
go/worker/common/p2p/dispatch.go 76.31% <0.00%> (-4.39%) ⬇️
...consensus/tendermint/apps/registry/transactions.go 56.16% <0.00%> (-1.65%) ⬇️
go/consensus/tendermint/roothash/roothash.go 71.75% <0.00%> (-0.85%) ⬇️
go/consensus/api/grpc.go 69.72% <0.00%> (-0.55%) ⬇️
go/consensus/tendermint/full/full.go 62.31% <0.00%> (-0.49%) ⬇️
.../consensus/tendermint/apps/registry/state/state.go 59.16% <0.00%> (ø)
go/worker/registration/worker.go 69.54% <0.00%> (+0.39%) ⬆️
go/consensus/tendermint/abci/mux.go 52.86% <0.00%> (+0.84%) ⬆️
go/worker/common/committee/group.go 79.24% <0.00%> (+0.94%) ⬆️
go/consensus/tendermint/abci/state.go 69.15% <0.00%> (+1.24%) ⬆️
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 767c163...8c00e65. Read the comment docs.

@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch 2 times, most recently from da9455e to 04bbf6d Compare July 10, 2020 13:38
docs/setup/deploying-a-runtime.md Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
```
mkdir /tmp/runtime-example

# TODO: this json fixture will probably be hard to keep up to date. Figure
Copy link
Member

Choose a reason for hiding this comment

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

If it's not tested periodically, it will rot.

Copy link
Member Author

@ptrus ptrus Jul 22, 2020

Choose a reason for hiding this comment

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

I fixed this by extending the default fixture command, and using that here instead of providing a separate json, which should be much better in terms of rotting, but still not perfect.

I think docs will generally tend to rot (specially the more low level ones) unless someone periodically goes over the docs and actually tries them out. Maybe adding a "make sure documentation is up to date" should be added to the process of creating major releases (as a manual step). However we do have quite a lot of docs already in this repository, so the exact step should probably be something like: "documentation owners" should make sure documentation is up to date with the version getting released - few days before releasing a new major version? ("documentation owners" - since it's probably a bit much for a single person to go over all).

edit: maybe a bit overkill for now, but in future we'll probably want something like this

docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch 6 times, most recently from 1be0136 to 9b663d9 Compare July 16, 2020 14:33
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch 3 times, most recently from f48ec9e to 0b080fa Compare July 22, 2020 08:49
@ptrus ptrus marked this pull request as ready for review July 22, 2020 16:47
@ptrus ptrus changed the title docs/setup/deploying-a-runtime: example on registering a runtime docs/setup/deploying-a-runtime: example of registering a runtime Jul 27, 2020
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch from 0b080fa to 469a1fc Compare August 3, 2020 15:13
Copy link
Member

@kostko kostko left a comment

Choose a reason for hiding this comment

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

Would be cool to get this merged.

docs/runtime/index.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch 4 times, most recently from a179b33 to b980a33 Compare August 21, 2020 10:50
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch from b980a33 to 5f400c2 Compare August 21, 2020 10:51
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
docs/setup/deploying-a-runtime.md Outdated Show resolved Hide resolved
@ptrus ptrus force-pushed the ptrus/docs/deploying-a-runtime branch from 5f400c2 to 8c00e65 Compare August 21, 2020 11:49
@ptrus ptrus merged commit 1551f4c into master Aug 21, 2020
@ptrus ptrus deleted the ptrus/docs/deploying-a-runtime branch August 21, 2020 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document deploying and operating a simple runtime
3 participants