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
Changes for GRPC Examples documentation and Consistency on Directory Structure
Fixes #5467