-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
generate docs for proto #3067
generate docs for proto #3067
Conversation
@@ -0,0 +1,455 @@ | |||
# Protocol Documentation |
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 ? |
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.
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.proto
usinghttps://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/references
Next 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