-
Notifications
You must be signed in to change notification settings - Fork 115
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
Conversation
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
da9455e
to
04bbf6d
Compare
docs/setup/deploying-a-runtime.md
Outdated
``` | ||
mkdir /tmp/runtime-example | ||
|
||
# TODO: this json fixture will probably be hard to keep up to date. Figure |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
1be0136
to
9b663d9
Compare
f48ec9e
to
0b080fa
Compare
0b080fa
to
469a1fc
Compare
There was a problem hiding this 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.
a179b33
to
b980a33
Compare
b980a33
to
5f400c2
Compare
5f400c2
to
8c00e65
Compare
Fixes: #3081
TODO:
depends on go/registry: Add support for querying suspended runtimes #3099