Skip to content

Commit d6f9ce7

Browse files
docs: updates outmoded steps from apps links (#2738)
1 parent e62c830 commit d6f9ce7

File tree

2 files changed

+7
-19
lines changed

2 files changed

+7
-19
lines changed

docs/english/legacy/steps-from-apps.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ A step from app is made up of three distinct user events:
2020

2121
All three events must be handled for a step from app to function.
2222

23-
Read more about steps from apps in the [API documentation](/legacy/legacy-steps-from-apps/).
24-
2523
---
2624

2725
## Creating steps from apps
@@ -55,14 +53,12 @@ app.step(ws);
5553

5654
## Adding or editing steps from apps
5755

58-
When a builder adds (or later edits) your step in their workflow, your app will receive a [`workflow_step_edit` event](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step_edit-payload/). The `edit` callback in your `WorkflowStep` configuration will be run when this event is received.
56+
When a builder adds (or later edits) your step in their workflow, your app will receive a `workflow_step_edit` event. The `edit` callback in your `WorkflowStep` configuration will be run when this event is received.
5957

60-
Whether a builder is adding or editing a step, you need to send them a [step from app configuration modal](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-configuration-view-object). 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 step from app.
58+
Whether a builder is adding or editing a step, you need to send them a step from app configuration modal. 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 step from app.
6159

6260
Within the `edit` callback, the `configure()` utility can be used to easily open your step's configuration modal by passing in an object with your view's `blocks`. To disable saving the configuration before certain conditions are met, pass in `submit_disabled` with a value of `true`.
6361

64-
To learn more about opening configuration modals, [read the documentation](/legacy/legacy-steps-from-apps/).
65-
6662
```javascript
6763
const ws = new WorkflowStep('add_task', {
6864
edit: async ({ ack, step, configure }) => {
@@ -121,8 +117,6 @@ Within the `save` callback, the `update()` method can be used to save the builde
121117
- `step_name` overrides the default Step name
122118
- `step_image_url` overrides the default Step image
123119

124-
To learn more about how to structure these parameters, [read the documentation](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object).
125-
126120
```javascript
127121
const ws = new WorkflowStep('add_task', {
128122
edit: async ({ ack, step, configure }) => {},
@@ -159,7 +153,7 @@ const ws = new WorkflowStep('add_task', {
159153

160154
## Executing steps from apps
161155

162-
When your step from app is executed by an end user, your app will receive a [`workflow_step_execute` event](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object). The `execute` callback in your `WorkflowStep` configuration will be run when this event is received.
156+
When your step from app is executed by an end user, your app will receive a `workflow_step_execute` event. The `execute` callback in your `WorkflowStep` configuration will be run when this event is received.
163157

164158
Using the `inputs` from the `save` callback, this is where you can make third-party API calls, save information to a database, update the user's Home tab, or decide the outputs that will be available to subsequent steps by mapping values to the `outputs` object.
165159

docs/japanese/legacy/steps-from-apps.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ワークフローステップの概要
22

3-
アプリによる)ワークフローステップ (Workflow Steps from Apps) は、[ワークフロービルダー](/legacy/legacy-steps-from-apps/)におけるワークフローに組み込み可能なカスタムのワークフローステップを任意の Slack アプリが提供することを可能とします。
3+
アプリによる)ワークフローステップ (Workflow Steps from Apps) は、ワークフロービルダーにおけるワークフローに組み込み可能なカスタムのワークフローステップを任意の Slack アプリが提供することを可能とします。
44

55
ワークフローステップは、三つの異なるユーザーイベントから構成されます:
66

@@ -10,8 +10,6 @@
1010

1111
ワークフローステップを機能させるためには、これら三つのイベント全てを適切にハンドリングする必要があります。
1212

13-
ワークフローステップのさらなる詳細については [API ドキュメント](/legacy/legacy-steps-from-apps/)を参考にしてください。
14-
1513
---
1614

1715
## ステップの定義
@@ -47,14 +45,12 @@ app.step(ws);
4745

4846
## ステップの追加・編集
4947

50-
ワークフローの作成者が、アプリが提供するステップをワークフローに追加(またはその設定を変更)するタイミングで、アプリは [`workflow_step_edit`](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step_edit-payload) というイベントを受信します。このイベントの受信時に `WorkflowStep` 設定オブジェクト内の `edit` コールバック関数が実行されます。
48+
ワークフローの作成者が、アプリが提供するステップをワークフローに追加(またはその設定を変更)するタイミングで、アプリは `workflow_step_edit` というイベントを受信します。このイベントの受信時に `WorkflowStep` 設定オブジェクト内の `edit` コールバック関数が実行されます。
5149

52-
このとき、ワークフロー作成・変更のどちらの場合でも、アプリは[ワークフローステップ設定のためのモーダル](/legacy/legacy-steps-from-apps/)を応答する必要があります。このモーダルは、ワークフローステップに固有の設定である必要があり、通常のモーダルにはない制約があります。最もわかりやすいものとしては、`title​``submit​``close` プロパティを設定することができません。また、デフォルトの設定では、この設定モーダルの `callback_id` はワークフローステップのものと同じものが使用されます。
50+
このとき、ワークフロー作成・変更のどちらの場合でも、アプリはワークフローステップ設定のためのモーダルを応答する必要があります。このモーダルは、ワークフローステップに固有の設定である必要があり、通常のモーダルにはない制約があります。最もわかりやすいものとしては、`title​``submit​``close` プロパティを設定することができません。また、デフォルトの設定では、この設定モーダルの `callback_id` はワークフローステップのものと同じものが使用されます。
5351

5452
`edit` コールバック関数の中では モーダルの view のうち `blocks` だけを渡すだけで簡単にステップ設定モーダルをオープンすることができる `configure()` というユーティリティ関数が利用できます。これは、必要な入力内容が揃うまで設定の保存を無効にする `submit_disabled` というオプションを `true` に設定します。
5553

56-
設定モーダルを開く処理に関するさらなる詳細は、[ドキュメント](/legacy/legacy-steps-from-apps/)を参考にしてください。
57-
5854
```javascript
5955
const ws = new WorkflowStep('add_task', {
6056
edit: async ({ ack, step, configure }) => {
@@ -115,8 +111,6 @@ const ws = new WorkflowStep('add_task', {
115111
- `step_name` は、デフォルトのステップ名を上書きするために使用します
116112
- `step_image_url` は、デフォルトのステップのイメージ画像を上書きするために使用します
117113

118-
これら引数をどのように構成するかの詳細は、[ドキュメント](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object)を参考にしてください。
119-
120114
```javascript
121115
const ws = new WorkflowStep('add_task', {
122116
edit: async ({ ack, step, configure }) => {},
@@ -156,7 +150,7 @@ const ws = new WorkflowStep('add_task', {
156150

157151
## ステップの実行
158152

159-
ワークフローの利用者によって、アプリが提供するカスタムのワークフローステップが実行されるとき、アプリは[`workflow_step_execute`](/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object) というイベントを受信します。このイベントの受信時に `WorkflowStep` 設定オブジェクト内の `execute` コールバック関数が実行されます。
153+
ワークフローの利用者によって、アプリが提供するカスタムのワークフローステップが実行されるとき、アプリは`workflow_step_execute` というイベントを受信します。このイベントの受信時に `WorkflowStep` 設定オブジェクト内の `execute` コールバック関数が実行されます。
160154

161155
`save` コールバック関数で予め規定された `inputs` の情報を使って、ここでの処理は、サードパーティの API を呼び出したり、データベースに情報を保存したり、そのユーザーのホームタブを更新したり、`outputs` オブジェクトを構築することで後続のワークフローステップが利用できる情報を設定したりします。
162156

0 commit comments

Comments
 (0)