examples: GRPC Examples documentation and Consistency on directory structure changes #11676
Conversation
vinodhabib
changed the title
|
|
||
| - [Load Balance](src/main/java/io/grpc/examples/loadbalance) | ||
|
|
||
| - [Multiplex](src/main/java/io/grpc/examples/multiplex) |
There was a problem hiding this comment.
Should we add a paragraph of explanation for non-trivial examples? As done for Retrying, Health Service, etc.
There was a problem hiding this comment.
not sure on this part as this is an existing one and can see the paragraph of explanation for only 3 examples not for all which are existing previously (except the newly added changes).
I can also see some doc comments in the implementation classes are giving some of the details.
| @@ -135,6 +136,24 @@ before trying out the examples. | |||
|
|
|||
| - [Keep Alive](src/main/java/io/grpc/examples/keepalive) | |||
There was a problem hiding this comment.
It is not clear to me which part of Sanjay Pujare's concerns this PR addresses.
"each example should have a README file which a user can read to understand the example." I don't find this done, for example there is no README for the subdirectories in https://github.com/grpc/grpc-java/tree/master/examples/src/main/java/io/grpc/examples.
There was a problem hiding this comment.
@kannanjgithub @shivaspeaks There is a common README file for all the examples (which are inside the path https://github.com/grpc/grpc-java/tree/master/examples/src/main/java/io/grpc/examples) as mentioned in the below link and updated some of the missing ones with recent changes as part of this PR.
Common README link in grpc-java - https://github.com/grpc/grpc-java/blob/master/examples/README.md
There was a problem hiding this comment.
The issue mentions "each example should have a README file which a user can read to understand the example." Merely enumerating the examples in the sub-directories to the parent README does not do that.
There was a problem hiding this comment.
I can see there are 21 examples, working on this comment and its in progress
There was a problem hiding this comment.
@kannanjgithub @shivaspeaks Added the Readme file with details for the all examples and its ready for Review. please have look once.
There was a problem hiding this comment.
@kannanjgithub @shivaspeaks Added the Readme file with details for the all examples and its ready for Review. please have look once.
@kannanjgithub @shivaspeaks This PR is pending for review from long time, Request you have a look once.
shivaspeaks
added
the
kokoro:run
grpc-kokoro
removed
the
kokoro:run
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
|
|
||
| This is a feature which can be used on a stub which will cause the RPCs to wait for the server to become available before sending the request. | ||
|
|
||
| When an RPC is created when the channel has failed to connect to the server, without Wait-for-Ready it will immediately return a failure, |
There was a problem hiding this comment.
Wording could be better here.
| This also gets the default features file (https://github.com/grpc/grpc-java/blob/master/examples/src/main/resources/io/grpc/examples/routeguide/route_guide_db.json) from common utility class | ||
| which internally loads from classpath along with getting the latitude and longitude for given point. | ||
|
|
||
| Refer the router_guid.proto definition/specification for all 4 types of RPCs |
There was a problem hiding this comment.
route_guide*
Also use markdown.
| @@ -0,0 +1,13 @@ | |||
| gRPC Compression Example | |||
| gRPC Multiplex Example | ||
| ===================== | ||
|
|
||
| This example gives the implementation of a gRPC Channel can be shared by two stubs and two services |
| entirely, set environment variable `DISABLE_RETRYING_IN_RETRYING_EXAMPLE=true` before running the client. | ||
| Disabling the retry policy should produce many more failed gRPC calls as seen in the output log. | ||
|
|
||
| See [the section below](#to-build-the-examples) for how to build and run the example. The |
There was a problem hiding this comment.
The link here takes us to nowhere.
| This example gives the usage and implementation of route guide server and client to demonstrate | ||
| how to use grpc libraries to perform all 4 types (unary, client streaming, server streaming and bidirectional) of RPC services and methods. | ||
|
|
||
| This also gets the default features file (https://github.com/grpc/grpc-java/blob/master/examples/src/main/resources/io/grpc/examples/routeguide/route_guide_db.json) from common utility class |
There was a problem hiding this comment.
Same. Needs rewording to use markdown for better readme.
Changes for GRPC Examples documentation and Consistency on Directory Structure
Fixes #5467