-
Notifications
You must be signed in to change notification settings - Fork 98
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 reference docs from proto files #982
Generate reference docs from proto files #982
Conversation
8f687a8
to
d28e5f7
Compare
Integrates `gen-proto-docs` into the project such that when generating Rust code from the protos, the reference documentation is generated at the same time. Closes googleforgames#981
The generated reference is always going to have broken anchors, so move it into its own directory, so we can tell htmltest to ignore it.
* Updated xds.md * Updated proto comments. * Added a few missing Apache headers
Took me a bit, but now I understand how more of the xDS implementation works! This should update the documentation appropriately now.
7010957
to
419f329
Compare
Sorry for the long delay - got pulled into a bunch of other things, and it took me a while to wrap my head around how the xDS system was working. I believe this should be good now, and close out #970, and also should set us up to expand the docs more by adding comments to the proto file, since it powers a reference doc for that layer. |
Build Failed 😭 Build Id: b1aba417-2142-497e-85d6-4548d09dee9f Status: FAILURE To get permission to view the Cloud Build view, join the quilkin-discuss Google Group. Filter with the Git Commit Development images are retained for at least 30 days. |
Interesting - if it continues to be a problem I'll ignore the link in the code. |
Weird, quilkin-bot didn't post. I'll have to look into why - but everything passed. Edit: oooh, I know why - it loses the PR number when I hit "retry" |
What type of PR is this?
/kind documentation
What this PR does / Why we need it:
Integrates
gen-proto-docs
into the project such that when generating Rust code from the protos, the reference documentation is generated at the same time.Which issue(s) this PR fixes:
Closes #981
Special notes for your reviewer:
Hopefully this helps with #970