Add Japanese translation of Steps from Apps documents

Author: seratch

docs/_config.yml

@@ -37,7 +37,7 @@ t:
     contribute: Contributing
   ja-jp:
     basic: 基本的な概念
-#    steps: ワークフローステップ
+    steps: ワークフローステップ
 #    advanced: 応用コンセプト
     start: Bolt 入門ガイド
 #    contribute: 貢献

docs/_steps/adding_editing_workflow_step.md

@@ -9,7 +9,7 @@ order: 3
 
 When a builder adds (or later edits) your step in their workflow, your app will receive a [`workflow_step_edit` event](https://api.slack.com/reference/workflows/workflow_step_edit). The `edit` callback in your `WorkflowStep` configuration will be run when this event is received.
 
-Whether a builder is adding or editing a step, you need to send them a [workflow step configuration modal](https://api.slack.com/reference/workflows/configuration-view). This modal is where step-specific settings are chosen, and it has more restrictions than typical modals—most notably, it cannot include `title​`, `submit​`, or `close`​ properties. By default, the configuration modal's `callback_id` will be the same as the workflow step.
+Whether a builder is adding or editing a step, you need to send them a [workflow step configuration modal](https://api.slack.com/reference/workflows/configuration-view). This modal is where step-specific settings are chosen, and it has more restrictions than typical modals—most notably, it cannot include `title`, `submit`, or `close` properties. By default, the configuration modal's `callback_id` will be the same as the workflow step.
 
 Within the `edit` callback, the `configure()` utility can be used to easily open your step's configuration modal by passing in the view's blocks with the corresponding `blocks` argument. To disable saving the configuration before certain conditions are met, you can also pass in `submit_disabled` with a value of `True`.
 

docs/_steps/ja_adding_editing_workflow_step.md

@@ -0,0 +1,55 @@
+---
+title: ステップの追加・編集
+lang: ja-jp
+slug: adding-editing-steps
+order: 3
+---
+
+<div class='section-content'>
+
+作成したワークフローステップがワークフローに追加またはその設定を変更されるタイミングで、[`workflow_step_edit` イベントがアプリに送信されます](https://api.slack.com/reference/workflows/workflow_step_edit)。このイベントがアプリに届くと、`WorkflowStep` で設定した `edit` コールバックが実行されます。
+
+ステップの追加と編集のどちらが行われるときも、[ワークフローステップの設定モーダル](https://api.slack.com/reference/workflows/configuration-view)をビルダーに送信する必要があります。このモーダルは、そのステップ独自の設定を選択するための場所です。通常のモーダルより制限が強く、例えば `title`、`submit`、`close` のプロパティを含めることができません。設定モーダルの `callback_id` は、デフォルトではワークフローステップと同じものになります。
+
+`edit` コールバック内で `configure()` ユーティリティを使用すると、対応する `blocks` 引数にビューのblocks 部分だけを渡して、ステップの設定モーダルを簡単に表示させることができます。必要な入力内容が揃うまで設定の保存を無効にするには、`True` の値をセットした `submit_disabled` を渡します。
+
+設定モーダルの開き方について詳しくは、[ドキュメントを参照してください](https://api.slack.com/workflows/steps#handle_config_view)。
+
+</div>
+
+```python
+def edit(ack, step, configure):
+    ack()
+
+    blocks = [
+        {
+            "type": "input",
+            "block_id": "task_name_input",
+            "element": {
+                "type": "plain_text_input",
+                "action_id": "name",
+                "placeholder": {"type": "plain_text", "text":"Add a task name"},
+            },
+            "label": {"type": "plain_text", "text":"Task name"},
+        },
+        {
+            "type": "input",
+            "block_id": "task_description_input",
+            "element": {
+                "type": "plain_text_input",
+                "action_id": "description",
+                "placeholder": {"type": "plain_text", "text":"Add a task description"},
+            },
+            "label": {"type": "plain_text", "text":"Task description"},
+        },
+    ]
+    configure(blocks=blocks)
+
+ws = WorkflowStep(
+    callback_id="add_task",
+    edit=edit,
+    save=save,
+    execute=execute,
+)
+app.step(ws)
+```

docs/_steps/ja_creating_workflow_step.md

@@ -0,0 +1,49 @@
+---
+title: ステップの定義
+lang: ja-jp
+slug: creating-steps
+order: 2
+---
+
+<div class='section-content'>
+
+ワークフローステップの作成には、Bolt が提供する `WorkflowStep` クラスを利用します。
+
+ステップの `callback_id` と設定オブジェクトを指定して、`WorkflowStep` の新しいインスタンスを作成します。
+
+設定オブジェクトは、`edit`、`save`、`execute` という 3 つのキーを持ちます。それぞれのキーは、単一のコールバック、またはコールバックのリストである必要があります。すべてのコールバックは、ワークフローステップのイベントに関する情報を保持する `step` オブジェクトにアクセスできます。
+
+`WorkflowStep` のインスタンスを作成したら、それを`app.step()` メソッドに渡します。これによって、アプリがワークフローステップのイベントをリッスンし、設定オブジェクトで指定されたコールバックを使ってそれに応答できるようになります。
+
+</div>
+
+```python
+import os
+from slack_bolt import App
+from slack_bolt.workflows.step import WorkflowStep
+
+# いつも通りBolt アプリを起動する
+app = App(
+    token=os.environ.get("SLACK_BOT_TOKEN"),
+    signing_secret=os.environ.get("SLACK_SIGNING_SECRET")
+)
+
+def edit(ack, step, configure):
+    pass
+
+def save(ack, view, update):
+    pass
+
+def execute(step, complete, fail):
+    pass
+
+# WorkflowStep の新しいインスタンスを作成する
+ws = WorkflowStep(
+    callback_id="add_task",
+    edit=edit,
+    save=save,
+    execute=execute,
+)
+# ワークフローステップを渡してリスナーを設定する
+app.step(ws)
+```

docs/_steps/ja_executing_workflow_steps.md

@@ -0,0 +1,39 @@
+---
+title: ステップの実行
+lang: ja-jp
+slug: executing-steps
+order: 5
+---
+
+<div class="section-content">
+
+エンドユーザーがワークフローステップを実行すると、アプリに [`workflow_step_execute` イベントが送信されます](https://api.slack.com/events/workflow_step_execute)。このイベントがアプリに届くと、`WorkflowStep` で設定した `execute` コールバックが実行されます。
+
+`save` コールバックで取り出した `inputs` を使って、サードパーティの API を呼び出す、情報をデータベースに保存する、ユーザーのホームタブを更新するといった処理を実行することができます。また、ワークフローの後続のステップで利用する出力値を `outputs` オブジェクトに設定します。
+
+`execute` コールバック内では、`complete()` を呼び出してステップの実行が成功したことを示すか、`fail()` を呼び出してステップの実行が失敗したことを示す必要があります。
+
+</div>
+
+```python
+def execute(step, complete, fail):
+    inputs = step["inputs"]
+    # すべての処理が成功した場合
+    outputs = {
+        "task_name": inputs["task_name"]["value"],
+        "task_description": inputs["task_description"]["value"],
+    }
+    complete(outputs=outputs)
+
+    # 失敗した処理がある場合
+    error = {"message":"Just testing step failure!"}
+    fail(error=error)
+
+ws = WorkflowStep(
+    callback_id="add_task",
+    edit=edit,
+    save=save,
+    execute=execute,
+)
+app.step(ws)
+```

docs/_steps/ja_saving_workflow_step.md

@@ -0,0 +1,56 @@
+---
+title: ステップの設定の保存
+lang: ja-jp
+slug: saving-steps
+order: 4
+---
+
+<div class='section-content'>
+
+設定モーダルを開いた後、アプリは `view_submission` イベントをリッスンします。このイベントがアプリに届くと、`WorkflowStep` で設定した `save` コールバックが実行されます。
+
+`save` コールバック内では、`update()` メソッドを使って、ワークフローに追加されたステップの設定を保存することができます。このメソッドには次の引数を指定します。
+
+- `inputs` : ユーザーがワークフローステップを実行したときにアプリが受け取る予定のデータを表す辞書型の値です。
+- `outputs` : ワークフローステップの完了時にアプリが出力するデータが設定されたオブジェクトのリストです。この outputs は、ワークフローの後続のステップで利用することができます。
+- `step_name` : ステップのデフォルトの名前をオーバーライドします。
+- `step_image_url` : ステップのデフォルトの画像をオーバーライドします。
+
+これらのパラメータの構成方法について詳しくは、[ドキュメントを参照してください](https://api.slack.com/reference/workflows/workflow_step)。
+
+</div>
+
+```python
+def save(ack, view, update):
+    ack()
+
+    values = view["state"]["values"]
+    task_name = values["task_name_input"]["name"]
+    task_description = values["task_description_input"]["description"]
+
+    inputs = {
+        "task_name": {"value": task_name["value"]},
+        "task_description": {"value": task_description["value"]}
+    }
+    outputs = [
+        {
+            "type": "text",
+            "name": "task_name",
+            "label":"Task name",
+        },
+        {
+            "type": "text",
+            "name": "task_description",
+            "label":"Task description",
+        }
+    ]
+    update(inputs=inputs, outputs=outputs)
+
+ws = WorkflowStep(
+    callback_id="add_task",
+    edit=edit,
+    save=save,
+    execute=execute,
+)
+app.step(ws)
+```

docs/_steps/ja_workflow_steps_overview.md

@@ -0,0 +1,21 @@
+---
+title: ワークフローステップの概要
+lang: ja-jp
+slug: steps-overview
+order: 1
+---
+
+<div class="section-content">
+（アプリによる）ワークフローステップでは、処理をアプリ側で行うカスタムのワークフローステップを提供することができます。ユーザーは[ワークフロービルダー](https://api.slack.com/workflows)を使ってこれらのステップをワークフローに追加できます。
+
+ワークフローステップは、次の 3 つのユーザーイベントで構成されます。
+
+- ワークフローステップをワークフローに追加・変更する
+- ワークフロー内のステップの設定内容を更新する
+- エンドユーザーがそのステップを実行する
+
+ワークフローステップを機能させるためには、これら 3 つのイベントすべてに対応する必要があります。
+
+アプリを使ったワークフローステップについて詳しくは、[API ドキュメント](https://api.slack.com/workflows/steps)を参照してください。
+
+</div>