-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixes #1219 - Adds documentation for socket mode and developer mode in Japanese #1226
Fixes #1219 - Adds documentation for socket mode and developer mode in Japanese #1226
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1226 +/- ##
=======================================
Coverage 73.22% 73.22%
=======================================
Files 17 17
Lines 1438 1438
Branches 431 431
=======================================
Hits 1053 1053
Misses 300 300
Partials 85 85 Continue to review full report at Codecov.
|
docs/_tutorials/ja_reference.md
Outdated
@@ -116,6 +116,9 @@ App オプションは、`App` のコンストラクターに渡します。 | |||
| `logLevel` | 出力するログのレベルを指定するオプション。`LogLevel` の出力に含まれる情報のレベルには、重要度の低い順から高い順に `DEBUG`、`INFO`、`WARN`、`ERROR` があります。デフォルトの `logLevel` は `INFO` に設定されています。ログ出力の詳細については、[ドキュメント](/bolt-js/concepts#logging)を参照してください。 | | |||
| `ignoreSelf` | アプリ自身から発信されたメッセージをミドルウェアの関数で無視するかどうかを指定する真偽値。`botId` が必要です。デフォルトは `true` です。 | | |||
| `clientOptions.slackApiUrl` | Slack Web API で使用するエンドポイントをカスタマイズできます。これが使用されるのはほとんどがテスト用途です。 | | |||
| `socketMode` | 真偽値を受け付けるオプションです. 真偽値を`true` に設定したとき、アプリは[ソケットモード](/bolt-js/concepts#socket-mode)で起動します。 ソケットモードは Slack からのデータを WebSocket の接続を通して受信する機能です。デフォルトは `false` です. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `socketMode` | 真偽値を受け付けるオプションです. 真偽値を`true` に設定したとき、アプリは[ソケットモード](/bolt-js/concepts#socket-mode)で起動します。 ソケットモードは Slack からのデータを WebSocket の接続を通して受信する機能です。デフォルトは `false` です. | |
| `socketMode` | 真偽値を指定するオプションで、`true` に設定するとアプリは[ソケットモード](/bolt-js/ja-jp/concepts#socket-mode)で起動します。 ソケットモードは WebSocket のコネクションを通して Slack からのデータを受信する機能です。デフォルトは `false` です。 |
docs/_tutorials/ja_reference.md
Outdated
@@ -131,7 +134,6 @@ Bolt では、さまざまなエラーが定義されています。これらに | |||
| `ReceiverMultipleAckError` | Receiver 内で、すでに確認が済んでいるリクエストに対してアプリがさらに `ack()` を呼んだ場合にスローされるエラーです。現在、デフォルトの `HTTPReceiver` でのみ使用されます。 | | |||
| `ReceiverAuthenticityError` | アプリのリクエストの署名が検証できないときにスローされるエラーです。このエラーには、失敗した理由を示す情報が含まれます(例 : タイムスタンプが有効でない、ヘッダーに抜けがある、署名シークレットが有効でない)。 | |||
| `MultipleListenerError` | 単一のイベントに対して複数のリスナーでの処理中に複数のエラーが発生した場合にスローされるエラーです。個々のエラーを配列に収めた `originals` プロパティを持ちます。 | | |||
| `WorkflowStepInitializationError` | 新しい `WorkflowStep` をインスタンス化する際に、設定オプションが無効な場合、または不足している場合にスローされるエラーです。原因として、`callback_id` が指定されていない、または設定オブジェクトが指定されていないことが考えられます。ワークフローステップについて詳しくは、[ドキュメント](/concepts#steps)を参照してください。 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you revert this change?
docs/_tutorials/ja_reference.md
Outdated
@@ -116,6 +116,9 @@ App オプションは、`App` のコンストラクターに渡します。 | |||
| `logLevel` | 出力するログのレベルを指定するオプション。`LogLevel` の出力に含まれる情報のレベルには、重要度の低い順から高い順に `DEBUG`、`INFO`、`WARN`、`ERROR` があります。デフォルトの `logLevel` は `INFO` に設定されています。ログ出力の詳細については、[ドキュメント](/bolt-js/concepts#logging)を参照してください。 | | |||
| `ignoreSelf` | アプリ自身から発信されたメッセージをミドルウェアの関数で無視するかどうかを指定する真偽値。`botId` が必要です。デフォルトは `true` です。 | | |||
| `clientOptions.slackApiUrl` | Slack Web API で使用するエンドポイントをカスタマイズできます。これが使用されるのはほとんどがテスト用途です。 | | |||
| `socketMode` | 真偽値を受け付けるオプションです. 真偽値を`true` に設定したとき、アプリは[ソケットモード](/bolt-js/concepts#socket-mode)で起動します。 ソケットモードは Slack からのデータを WebSocket の接続を通して受信する機能です。デフォルトは `false` です. | |||
| `developerMode` | デベロッパーモードを有効にする真偽地です。 `true` に設定したとき、`logLevel` は `DEBUG` に、そして`socketMode` は `true` に自動的に設定されます。 しかし、 | |||
`logLevel` と `socketMode` の二つのプロパティのいずれかが明示的に設定した場合、設定した値が優先されます。 また、デバッグに役たつ OAuth のエラーハンドラーが提供されます。 最後に、 Slack からのリクエストが全てログ出力されるのでトークンのような重要なデータがログに含まれる可能性があります。デフォルトは `false` です。 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`logLevel` と `socketMode` の二つのプロパティのいずれかが明示的に設定した場合、設定した値が優先されます。 また、デバッグに役たつ OAuth のエラーハンドラーが提供されます。 最後に、 Slack からのリクエストが全てログ出力されるのでトークンのような重要なデータがログに含まれる可能性があります。デフォルトは `false` です。 | | |
これらの二つのプロパティを明示的に設定した場合、それらの設定が `developerMode` による設定よりも優先されます。さらに、デバッグをしやすくするためのカスタムの OAuth エラーハンドラーも提供されます。 また、全ての Slack からのリクエストのボディがログ出力されるため、トークンのようなセンシティブな情報がログに含まれる可能性があります。デフォルトは `false` です。| |
docs/_tutorials/ja_reference.md
Outdated
@@ -116,6 +116,9 @@ App オプションは、`App` のコンストラクターに渡します。 | |||
| `logLevel` | 出力するログのレベルを指定するオプション。`LogLevel` の出力に含まれる情報のレベルには、重要度の低い順から高い順に `DEBUG`、`INFO`、`WARN`、`ERROR` があります。デフォルトの `logLevel` は `INFO` に設定されています。ログ出力の詳細については、[ドキュメント](/bolt-js/concepts#logging)を参照してください。 | | |||
| `ignoreSelf` | アプリ自身から発信されたメッセージをミドルウェアの関数で無視するかどうかを指定する真偽値。`botId` が必要です。デフォルトは `true` です。 | | |||
| `clientOptions.slackApiUrl` | Slack Web API で使用するエンドポイントをカスタマイズできます。これが使用されるのはほとんどがテスト用途です。 | | |||
| `socketMode` | 真偽値を受け付けるオプションです. 真偽値を`true` に設定したとき、アプリは[ソケットモード](/bolt-js/concepts#socket-mode)で起動します。 ソケットモードは Slack からのデータを WebSocket の接続を通して受信する機能です。デフォルトは `false` です. | |||
| `developerMode` | デベロッパーモードを有効にする真偽地です。 `true` に設定したとき、`logLevel` は `DEBUG` に、そして`socketMode` は `true` に自動的に設定されます。 しかし、 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `developerMode` | デベロッパーモードを有効にする真偽地です。 `true` に設定したとき、`logLevel` は `DEBUG` に、そして`socketMode` は `true` に自動的に設定されます。 しかし、 | |
| `developerMode` | デベロッパーモードを有効にする真偽値です。 `true` に設定したとき、`logLevel` は `DEBUG`、 `socketMode` は `true` に自動的に設定されます。しかし、 |
Summary
Fixes #1219. Adds socket mode and developer mode property descriptions in Japanese
Requirements (place an
x
in each[ ]
)