generate docs for proto#3067
Conversation
| @@ -0,0 +1,455 @@ | |||
| # Protocol Documentation | |||
There was a problem hiding this comment.
This file is generated by https://github.com/pseudomuto/protoc-gen-doc/tree/f2fcd98d4c7d0203f2eb091c3a3cb4f16ba233a7#invoking-the-plugin
Please see ./hack/proto/Dockerfile for details.
|
Please visit http://35.236.87.39:1313 to view changes to the docs. |
There was a problem hiding this comment.
Looks great!
We should add the link to the front matter as well on http://35.236.87.39:1313/docs/references/, also we should make sure it shows up in the menu:
I listed the reason, why this is not discoverable in the description here The reason, this is POC for how the generated API docs look Do you still think its ok to show ? |
balopat
left a comment
There was a problem hiding this comment.
Fair enough, let's not link it in just yet, let's iterate on it a bit more

Relates to #3023
Description
Generates API docs for skaffold Trigger, Control and Event API from
skaffold.protousinghttps://github.com/pseudomuto/protoc-gen-doc/tree/f2fcd98d4c7d0203f2eb091c3a3cb4f16ba233a7#invoking-the-plugin
User facing changes
yes
Before
no reference generated for all skaffold protos.
After
Please see http://35.236.87.39:1313/docs/references/api/
Note: This page is not discoverable to user and not linked anywhere.
The reason,
skaffold.dev/referencesNext PRs.
n/a
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Reviewer Notes
Release Notes