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

generate docs for proto #3067

Merged
merged 2 commits into from
Oct 16, 2019

Conversation

tejal29
Copy link
Contributor

@tejal29 tejal29 commented Oct 16, 2019

Relates to #3023

Description

Generates API docs for skaffold Trigger, Control and Event API from skaffold.proto using
https://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,

  • this is POC for how the generated API docs look
  • most of the fields in the proto are missing description and we shd add those before linking it in 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:

  • Includes unit tests
  • Mentions any output changes.
  • Adds documentation as needed: user docs, YAML reference, CLI reference.
  • Adds integration tests if needed.

See the contribution guide for more details.

Reviewer Notes

  • The code flow looks good.
  • Unit test added.
  • User facing changes look good.

Release Notes

@@ -0,0 +1,455 @@
# Protocol Documentation
Copy link
Contributor Author

@tejal29 tejal29 Oct 16, 2019

Choose a reason for hiding this comment

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

@tejal29 tejal29 added the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@container-tools-bot
Copy link

Please visit http://35.236.87.39:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@codecov
Copy link

codecov bot commented Oct 16, 2019

Codecov Report

Merging #3067 into master will not change coverage.
The diff coverage is n/a.

@tejal29 tejal29 changed the title generate api for proto generate docs for proto Oct 16, 2019
@tejal29 tejal29 mentioned this pull request Oct 16, 2019
7 tasks
Copy link
Contributor

@balopat balopat left a 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:

image

@tejal29
Copy link
Contributor Author

tejal29 commented Oct 16, 2019

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:

image

I listed the reason, why this is not discoverable in the description here
#3067 (comment)

The reason,

this is POC for how the generated API docs look
most of the fields in the proto are missing description and we shd add those before linking it in skaffold.dev/references

Do you still think its ok to show ?

Copy link
Contributor

@balopat balopat left a 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

@tejal29 tejal29 merged commit ea3767d into GoogleContainerTools:master Oct 16, 2019
@tejal29 tejal29 deleted the generate_proto_ref branch April 15, 2021 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants