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

Add a link to protobuf-grpc-service design page in proto doc #310

Merged
merged 2 commits into from
Jun 28, 2022

Conversation

yabuchan
Copy link
Contributor

@yabuchan yabuchan commented Jun 15, 2022

Why are these changes needed?

Description in ProtoBuf Definitions does not include enough details to start implementing a client, and more details are described in design doc. So I think adding a link to design doc in API reference documentation section of ProtoBuf Definitions page is helpful for first comers.

Also, proto buf in design doc is outdated, so it should be updated.

Changes:

  • Add a link to protobuf-grpc-service design page in proto doc
  • Update outdated proto definition in design page

Related issue number

Closes #309

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@Jeffwan
Copy link
Collaborator

Jeffwan commented Jun 28, 2022

Thanks for the contribution. It looks good to me.

@Jeffwan Jeffwan merged commit 85c548b into ray-project:master Jun 28, 2022
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Add a link to protobuf-grpc-service design page in proto doc and update the design page
2 participants