examples: Added README files for all missing Examples #11676
Conversation
vinodhabib
changed the title
| @@ -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.
|
I see this says |
@ejona86 Thanks for your reply, I was refering to one of the change as the "directory structure" for example-alts as it is not consistant with all the other examples projects directory so made this change/move as below in this PR apart from this no other changes related to directory structure.
"GRPC Example documentation" was refering here only for adding new README files in all examples with explanations nothing else. |
vinodhabib
changed the title
vinodhabib
changed the title
shivaspeaks
changed the title
| 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](https://github.com/grpc/grpc-java/blob/master/COMPILING.md) for how to build and run the example. The |
There was a problem hiding this comment.
I don't think this link is pointing to the right target. The content of build the example is what we wanted.
shivaspeaks
added
the
kokoro:run
grpc-kokoro
removed
the
kokoro:run
As part of this PR added a new README files for all the examples with details and made consistency on directory structure for example-alts similar to other existing examples projects.
Fixes #5467