temporalio / temporalio/samples-java
[Feature Request] Add troubleshooting details to
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 258
- Forks
- 189
- Avg merge
- 6d 4h
- Merged PRs (30d)
- 4
Description
Is your feature request related to a problem? Please describe.
Running the SslEnabledWorkerCustomCASample and forgetting to start the server-sample results in an exception.
Describe the solution you'd like
In the readme - https://github.com/temporalio/samples-java/blob/main/core/src/main/java/io/temporal/samples/ssl/README.md, it would be nice to add a troubleshooting section in the Run SslEnabledWorkerCustomCASample. Even better, modify the sample to catch this error and return a helpful message, like "Did you start the server-sample?"
Example for a troubleshooting section:
- If you receive an error message similar to
Exception in thread "main" io.grpc.StatusRuntimeException: UNAVAILABLE: io exception
This likely means you forgot to run the server-sample, located here: https://github.com/temporalio/samples-server/tree/main/tls/tls-simple
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open core/src/main/java/io/temporal/samples/ssl/README.md and start at the Run SslEnabledWorkerCustomCASample instructions. Add the requested troubleshooting guidance for the UNAVAILABLE exception, including the server-sample location and startup requirement; done means the README explains how to diagnose this failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100