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 reference docs from proto files #982

Merged
merged 4 commits into from
Aug 2, 2024

Conversation

markmandel
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature

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

@github-actions github-actions bot added kind/documentation Improvements or additions to documentation size/l labels Jun 14, 2024
@markmandel markmandel force-pushed the docs/protoc-gen-doc branch 2 times, most recently from 8f687a8 to d28e5f7 Compare June 14, 2024 22:56
This was referenced Jun 25, 2024
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.
@markmandel markmandel force-pushed the docs/protoc-gen-doc branch from 7010957 to 419f329 Compare August 1, 2024 22:53
@github-actions github-actions bot added size/xl and removed size/l labels Aug 1, 2024
@markmandel
Copy link
Contributor Author

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.

@quilkin-bot
Copy link
Collaborator

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 419f329 within us-docker.pkg.dev/quilkin/ci//quilkin to see if a development image is available from this build, and can be used for debugging purposes.

Development images are retained for at least 30 days.

@markmandel
Copy link
Contributor Author

========================================================================
book/third-party/presentations.html
  request exceeded our ExternalTimeout --- book/third-party/presentations.html --> https://www.gdcvault.com/play/1029264/Open-Source-Game-Development-Summit
========================================================================

Interesting - if it continues to be a problem I'll ignore the link in the code.

@markmandel
Copy link
Contributor Author

markmandel commented Aug 2, 2024

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"

@XAMPPRocky XAMPPRocky merged commit f7bee15 into googleforgames:main Aug 2, 2024
10 checks passed
@markmandel markmandel deleted the docs/protoc-gen-doc branch August 13, 2024 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation size/xl
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate documentation from proto files
3 participants