docs: improve grpc third party client documentation #5047
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samsja
changed the title
JohannesMessner
suggested changes
Aug 8, 2022
Comment on lines
+239
to
+242
| * Add the generated files to your project and import them in your code. | ||
|
|
||
| You should finally be able to communicate with your Flow using the gRPC protocol. You can find more information on the gRPC | ||
| `message` and `service` that you can use to communicate in the [Protobuf documentation](../../proto/docs.md). |
There was a problem hiding this comment.
What is this code that they will compile and add to their project? stubs that they can call directly? should we mention how this works or is that outside of our scope here?
There was a problem hiding this comment.
It is out of the scope I believe. The only way to do it correctly is to
- have a good proto documentation which explain the stubs that should be use etcc
- have a good how to with another language
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
|
📝 Docs are deployed on https://docs-improve-client--jina-docs.netlify.app 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Right now the docs to use grpc from an other language are really shallow.
docs to check for review :
What this pr do