Skip to content

Commit fbd6462

Browse files
chore: purge the "workflow step" terminology (#1124)
* chore: purge the workflow step terminology * Improve with s * Update docs/content/steps/steps.md Co-authored-by: Fil Maj <[email protected]> --------- Co-authored-by: Fil Maj <[email protected]>
1 parent b0be91a commit fbd6462

28 files changed

+95
-95
lines changed

docs/content/steps/adding-editing-steps.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Adding or editing workflow steps
2+
title: Adding or editing steps from apps
33
lang: en
44
slug: /concepts/adding-editing-steps
55
---
66

77
:::danger
88

9-
Workflow Steps from Apps are a deprecated feature.
9+
Steps from apps are a deprecated feature.
1010

11-
Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt.
11+
Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt.
1212

1313
Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information.
1414

1515
:::
1616

1717
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.
1818

19-
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.
19+
Whether a builder is adding or editing a step, you need to send them a [step from app 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 step from app.
2020

2121
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`.
2222

@@ -59,4 +59,4 @@ ws = WorkflowStep(
5959
execute=execute,
6060
)
6161
app.step(ws)
62-
```
62+
```

docs/content/steps/creating-steps.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
2-
title: Creating workflow steps
2+
title: Creating steps from apps
33
lang: en
44
slug: /concepts/creating-steps
55
---
66

77
:::danger
88

9-
Workflow Steps from Apps are a deprecated feature.
9+
Steps from apps are a deprecated feature.
1010

11-
Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt.
11+
Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt.
1212

1313
Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information.
1414

1515
:::
1616

17-
To create a workflow step, Bolt provides the `WorkflowStep` class.
17+
To create a step from app, Bolt provides the `WorkflowStep` class.
1818

1919
When instantiating a new `WorkflowStep`, pass in the step's `callback_id` and a configuration object.
2020

21-
The configuration object contains three keys: `edit`, `save`, and `execute`. Each of these keys must be a single callback or a list of callbacks. All callbacks have access to a `step` object that contains information about the workflow step event.
21+
The configuration object contains three keys: `edit`, `save`, and `execute`. Each of these keys must be a single callback or a list of callbacks. All callbacks have access to a `step` object that contains information about the step from app event.
2222

23-
After instantiating a `WorkflowStep`, you can pass it into `app.step()`. Behind the scenes, your app will listen and respond to the workflow step’s events using the callbacks provided in the configuration object.
23+
After instantiating a `WorkflowStep`, you can pass it into `app.step()`. Behind the scenes, your app will listen and respond to the step’s events using the callbacks provided in the configuration object.
2424

25-
Alternatively, workflow steps can also be created using the `WorkflowStepBuilder` class alongside a decorator pattern. For more information, including an example of this approach, [refer to the documentation](https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/step.html#slack_bolt.workflows.step.step.WorkflowStepBuilder).
25+
Alternatively, steps from apps can also be created using the `WorkflowStepBuilder` class alongside a decorator pattern. For more information, including an example of this approach, [refer to the documentation](https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/step.html#slack_bolt.workflows.step.step.WorkflowStepBuilder).
2626

2727
Refer to the module documents (<a href="https://slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html">common</a> / <a href="https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/utilities/index.html">step-specific</a>) to learn the available arguments.
2828

@@ -56,4 +56,4 @@ ws = WorkflowStep(
5656

5757
# Pass Step to set up listeners
5858
app.step(ws)
59-
```
59+
```

docs/content/steps/executing-steps.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Executing workflow steps
2+
title: Executing steps from apps
33
lang: en
44
slug: /concepts/executing-steps
55
---
66

77
:::danger
88

9-
Workflow Steps from Apps are a deprecated feature.
9+
Steps from apps are a deprecated feature.
1010

11-
Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt.
11+
Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt.
1212

1313
Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information.
1414

1515
:::
1616

17-
When your workflow step is executed by an end user, your app will receive a [`workflow_step_execute` event](https://api.slack.com/events/workflow_step_execute). The `execute` callback in your `WorkflowStep` configuration will be run when this event is received.
17+
When your step from app is executed by an end user, your app will receive a [`workflow_step_execute` event](https://api.slack.com/events/workflow_step_execute). The `execute` callback in your `WorkflowStep` configuration will be run when this event is received.
1818

19-
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 workflow steps by mapping values to the `outputs` object.
19+
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 from apps by mapping values to the `outputs` object.
2020

2121
Within the `execute` callback, your app must either call `complete()` to indicate that the step's execution was successful, or `fail()` to indicate that the step's execution failed.
2222

@@ -42,4 +42,4 @@ ws = WorkflowStep(
4242
execute=execute,
4343
)
4444
app.step(ws)
45-
```
45+
```

docs/content/steps/saving-steps.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ slug: /concepts/saving-steps
66

77
:::danger
88

9-
Workflow Steps from Apps are a deprecated feature.
9+
Steps from apps are a deprecated feature.
1010

11-
Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt.
11+
Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt.
1212

1313
Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information.
1414

@@ -18,8 +18,8 @@ After the configuration modal is opened, your app will listen for the `view_subm
1818

1919
Within the `save` callback, the `update()` method can be used to save the builder's step configuration by passing in the following arguments:
2020

21-
- `inputs` is a dictionary representing the data your app expects to receive from the user upon workflow step execution.
22-
- `outputs` is a list of objects containing data that your app will provide upon the workflow step's completion. Outputs can then be used in subsequent steps of the workflow.
21+
- `inputs` is a dictionary representing the data your app expects to receive from the user upon step execution.
22+
- `outputs` is a list of objects containing data that your app will provide upon the step's completion. Outputs can then be used in subsequent steps of the workflow.
2323
- `step_name` overrides the default Step name
2424
- `step_image_url` overrides the default Step image
2525

@@ -59,4 +59,4 @@ ws = WorkflowStep(
5959
execute=execute,
6060
)
6161
app.step(ws)
62-
```
62+
```

docs/content/steps/steps.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: Overview of Workflow Steps for apps
2+
title: Overview of steps from apps
33
lang: en
44
slug: /concepts/steps
55
---
66

77
:::danger
88

9-
Workflow Steps from Apps are a deprecated feature.
9+
Steps from apps are a deprecated feature.
1010

11-
Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt.
11+
Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt.
1212

1313
Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information.
1414

1515
:::
1616

17-
Steps from Apps for legacy workflows are now deprecated. Use new [custom steps](https://api.slack.com/automation/functions/custom-bolt).
17+
Steps from apps for legacy workflows are now deprecated. Use new [custom steps](https://api.slack.com/automation/functions/custom-bolt).
1818

19-
Workflow Steps from apps allow your app to create and process custom workflow steps that users can add using [Workflow Builder](https://api.slack.com/workflows).
19+
Steps from apps allow your app to create and process steps that users can add using [Workflow Builder](https://api.slack.com/workflows).
2020

21-
A workflow step is made up of three distinct user events:
21+
Steps from apps are made up of three distinct user events:
2222

2323
- Adding or editing the step in a Workflow
2424
- Saving or updating the step's configuration
2525
- The end user's execution of the step
2626

27-
All three events must be handled for a workflow step to function.
27+
All three events must be handled for a step from app to function.
2828

29-
Read more about workflow steps from apps in the [API documentation](https://api.slack.com/workflows/steps).
29+
Read more about steps from apps in the [API documentation](https://api.slack.com/workflows/steps).

docs/i18n/ja-jp/docusaurus-plugin-content-docs/current.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
"message": "応用コンセプト",
1212
"description": "The label for category Advanced concepts in sidebar sidebarBoltPy"
1313
},
14-
"sidebar.sidebarBoltPy.category.Workflow steps (Deprecated)": {
14+
"sidebar.sidebarBoltPy.category.steps from apps (Deprecated)": {
1515
"message": "ワークフローステップ 非推奨",
16-
"description": "The label for category Workflow steps (Deprecated) in sidebar sidebarBoltPy"
16+
"description": "The label for category steps from apps (Deprecated) in sidebar sidebarBoltPy"
1717
},
1818
"sidebar.sidebarBoltPy.category.Tutorials": {
1919
"message": "チュートリアル",

docs/sidebars.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ const sidebars = {
6262
'advanced/global-middleware',
6363
'advanced/context',
6464
'advanced/lazy-listeners',
65-
],
65+
],
6666
},
6767
{
6868
type: 'category',
69-
label: 'Workflow steps (Deprecated)',
69+
label: 'Steps from apps (Deprecated)',
7070
items: [
7171
'steps/steps',
7272
'steps/executing-steps',
@@ -75,21 +75,21 @@ const sidebars = {
7575
'steps/saving-steps',
7676
],
7777
},
78-
{type: 'html', value: '<hr>'},
78+
{ type: 'html', value: '<hr>' },
7979
{
8080
type: 'category',
8181
label: 'Tutorials',
8282
items: [
8383
'tutorial/getting-started-http'
8484
],
8585
},
86-
{type: 'html', value: '<hr>'},
86+
{ type: 'html', value: '<hr>' },
8787
{
8888
type: 'link',
8989
label: 'Reference',
9090
href: 'https://slack.dev/bolt-python/api-docs/slack_bolt/',
9191
},
92-
{type: 'html', value: '<hr>'},
92+
{ type: 'html', value: '<hr>' },
9393
{
9494
type: 'link',
9595
label: 'Release notes',

examples/workflow_steps/async_steps_from_apps.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
)
1111

1212
################################################################################
13-
# Steps from Apps for legacy workflows are now deprecated. #
13+
# Steps from apps for legacy workflows are now deprecated. #
1414
# Use new custom steps: https://api.slack.com/automation/functions/custom-bolt #
1515
################################################################################
1616

examples/workflow_steps/async_steps_from_apps_decorator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
)
1313

1414
################################################################################
15-
# Steps from Apps for legacy workflows are now deprecated. #
15+
# Steps from apps for legacy workflows are now deprecated. #
1616
# Use new custom steps: https://api.slack.com/automation/functions/custom-bolt #
1717
################################################################################
1818

examples/workflow_steps/async_steps_from_apps_primitive.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from slack_bolt.async_app import AsyncApp, AsyncAck
55

66
################################################################################
7-
# Steps from Apps for legacy workflows are now deprecated. #
7+
# Steps from apps for legacy workflows are now deprecated. #
88
# Use new custom steps: https://api.slack.com/automation/functions/custom-bolt #
99
################################################################################
1010

0 commit comments

Comments
 (0)