temporalio / temporalio/samples-java
[Feature Request] Add troubleshooting details to
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 258
- フォーク
- 189
- 平均マージ
- 6日 4時間
- マージ済み PR(30日)
- 4
説明
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
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
core/src/main/java/io/temporal/samples/ssl/README.md を開き、Run SslEnabledWorkerCustomCASample の手順から始めます。UNAVAILABLE 例外に対して要求されているトラブルシューティングの説明を追加します。server-sample の場所と起動要件も含めます。README でこの失敗の診断方法が説明されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 58/100