Skip to content

Commit f5916b1

Browse files
admonitions
1 parent 12879d9 commit f5916b1

File tree

8 files changed

+25
-42
lines changed

8 files changed

+25
-42
lines changed

docs/english/concepts/acknowledge.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ Depending on the type of request, your acknowledgement may be different. For exa
1010

1111
We recommend calling `ack()` right away before initiating any time-consuming processes such as fetching information from your database or sending a new message, since you only have 3 seconds to respond before Slack registers a timeout error.
1212

13-
:::info
14-
15-
When working in a FaaS / serverless environment, our guidelines for when to `ack()` are different. See the section on [Lazy listeners (FaaS)](/concepts/lazy-listeners) for more detail on this.
13+
:::info[When working in a FaaS / serverless environment, our guidelines for when to `ack()` are different. See the section on [Lazy listeners (FaaS)](/concepts/lazy-listeners) for more detail on this.]
1614

1715
:::
1816

docs/english/concepts/ai-apps.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ AI apps comprise a new messaging experience for Slack. If you're unfamiliar with
2424
* [`assistant_thread_context_changed`](https://docs.slack.dev/reference/events/assistant_thread_context_changed)
2525
* [`message.im`](https://docs.slack.dev/reference/events/message.im)
2626

27-
:::info
28-
You _could_ implement your own AI app by [listening](event-listening) for the `assistant_thread_started`, `assistant_thread_context_changed`, and `message.im` events (see implementation details below). That being said, using the `Assistant` class will streamline the process. And we already wrote this nice guide for you!
27+
:::info[You _could_ implement your own AI app by [listening](event-listening) for the `assistant_thread_started`, `assistant_thread_context_changed`, and `message.im` events (see implementation details below).]
28+
29+
That being said, using the `Assistant` class will streamline the process. And we already wrote this nice guide for you!
30+
2931
:::
3032

3133
## The `Assistant` class instance {#assistant-class}
@@ -101,16 +103,14 @@ While the `assistant_thread_started` and `assistant_thread_context_changed` even
101103

102104
If you do provide your own `threadContextStore` property, it must feature `get` and `save` methods.
103105

104-
:::tip
105-
Refer to the [module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.
106+
:::tip[Refer to the [module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.]
106107
:::
107108

108109
## Handling a new thread {#handling-a-new-thread}
109110

110111
When the user opens a new thread with your AI app, the [`assistant_thread_started`](https://docs.slack.dev/reference/events/assistant_thread_started) event will be sent to your app.
111112

112-
:::tip
113-
When a user opens an AI app thread while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info by using the `get_thread_context` utility, as subsequent user message event payloads won't include the channel info.
113+
:::tip[When a user opens an AI app thread while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info by using the `get_thread_context` utility, as subsequent user message event payloads won't include the channel info.]
114114
:::
115115

116116
### Block Kit interactions in the AI app thread {#block-kit-interactions}

docs/english/concepts/message-listening.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ To listen to messages that [your app has access to receive](https://docs.slack.d
88

99
`message()` accepts an argument of type `str` or `re.Pattern` object that filters out any messages that don't match the pattern.
1010

11-
:::info
12-
13-
Refer to [the module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.
11+
:::info[Refer to [the module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.]
1412

1513
:::
1614

docs/english/concepts/web-api.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ You can call [any Web API method](https://docs.slack.dev/reference/methods) usin
88

99
The token used to initialize Bolt can be found in the `context` object, which is required to call most Web API methods.
1010

11-
:::info
12-
13-
Refer to [the module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.
11+
:::info[Refer to [the module document](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html) to learn the available listener arguments.]
1412

1513
:::
1614

docs/english/getting-started.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ When you're finished, you'll have this ⚡️[Getting Started with Slack app](ht
1515
### Create an app {#create-an-app}
1616
First thing's first: before you start developing with Bolt, you'll want to [create a Slack app](https://api.slack.com/apps/new).
1717

18-
:::tip
19-
20-
We recommend using a workspace where you won't disrupt real work getting done — [you can create a new one for free](https://slack.com/get-started#create).
18+
:::tip[We recommend using a workspace where you won't disrupt real work getting done — [you can create a new one for free](https://slack.com/get-started#create).]
2119

2220
:::
2321

@@ -55,9 +53,7 @@ We're going to use bot and app-level tokens for this guide.
5553

5654
6. Navigate to **Socket Mode** on the left side menu and toggle to enable.
5755

58-
:::tip
59-
60-
Treat your tokens like passwords and [keep them safe](https://docs.slack.dev/authentication/best-practices-for-security). Your app uses tokens to post and retrieve information from Slack workspaces.
56+
:::tip[Treat your tokens like passwords and [keep them safe](https://docs.slack.dev/authentication/best-practices-for-security). Your app uses tokens to post and retrieve information from Slack workspaces.]
6157

6258
:::
6359

@@ -169,9 +165,9 @@ When an event occurs, Slack will send your app some information about the event,
169165

170166
2. Add your Request URL. Slack will send HTTP POST requests corresponding to events to this [Request URL](https://docs.slack.dev/apis/events-api/#subscribing) endpoint. Bolt uses the `/slack/events` path to listen to all incoming requests (whether shortcuts, events, or interactivity payloads). When configuring your Request URL within your app configuration, you'll append `/slack/events`, e.g. `https://<your-domain>/slack/events`. 💡 As long as your Bolt app is still running, your URL should become verified.
171167

172-
:::tip
168+
:::tip[For local development, you can use a proxy service like ngrok to create a public URL and tunnel requests to your development environment.]
173169

174-
For local development, you can use a proxy service like ngrok to create a public URL and tunnel requests to your development environment. Refer to [ngrok's getting started guide](https://ngrok.com/docs#getting-started-expose) on how to create this tunnel. And when you get to hosting your app, we've collected some of the most common hosting providers Slack developers use to host their apps [on our API site](https://docs.slack.dev/distribution/hosting-slack-apps/).
170+
Refer to [ngrok's getting started guide](https://ngrok.com/docs#getting-started-expose) on how to create this tunnel. And when you get to hosting your app, we've collected some of the most common hosting providers Slack developers use to host their apps [on our API site](https://docs.slack.dev/distribution/hosting-slack-apps/).
175171

176172
:::
177173

@@ -266,9 +262,9 @@ With Socket Mode on, basic interactivity is enabled by default, so no further ac
266262

267263
Similar to events, you'll need to specify a URL for Slack to send the action (such as *user clicked a button*). Back on your app configuration page, click on **Interactivity & Shortcuts** on the left side. You'll see that there's another **Request URL** box.
268264

269-
:::tip
265+
:::tip[By default, Bolt is configured to use the same endpoint for interactive components that it uses for events]
270266

271-
By default, Bolt is configured to use the same endpoint for interactive components that it uses for events, so use the same request URL as above (for example, `https://8e8ec2d7.ngrok.io/slack/events`). Press the **Save Changes** button in the lower right hand corner, and that's it. Your app is set up to handle interactivity!
267+
Use the same request URL as above (for example, `https://8e8ec2d7.ngrok.io/slack/events`). Press the **Save Changes** button in the lower right hand corner, and that's it. Your app is set up to handle interactivity!
272268

273269
:::
274270

@@ -366,9 +362,9 @@ The value inside of `say()` is now an object that contains an array of `blocks`.
366362

367363
You'll notice in the button `accessory` object, there is an `action_id`. This will act as a unique identifier for the button so your app can specify what action it wants to respond to.
368364

369-
:::tip
365+
:::tip[The [Block Kit Builder](https://app.slack.com/block-kit-builder) is a simple way to prototype your interactive messages.]
370366

371-
The [Block Kit Builder](https://app.slack.com/block-kit-builder) is an simple way to prototype your interactive messages. The builder lets you (or anyone on your team) mockup messages and generates the corresponding JSON that you can paste directly in your app.
367+
The builder lets you (or anyone on your team) mockup messages and generates the corresponding JSON that you can paste directly in your app.
372368

373369
:::
374370

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ lang: en
44
slug: /legacy/steps-from-apps
55
---
66

7-
:::danger
8-
9-
Steps from Apps is a deprecated feature.
7+
:::danger[Steps from Apps is a deprecated feature.]
108

119
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://docs.slack.dev/workflows/), such as [custom steps for Bolt](https://docs.slack.dev/workflows/workflow-steps).
1210

docs/english/tutorial/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,7 @@ You'll know the local development server is up and running successfully when it
120120

121121
With your development server running, continue to the next step.
122122

123-
:::info
124-
If you need to stop running the local development server, press `<CTRL>` + `c` to end the process.
123+
:::info[If you need to stop running the local development server, press `<CTRL>` + `c` to end the process.]
125124
:::
126125

127126
## Wiring up the sample step in Workflow Builder {#wfb}

docs/japanese/getting-started.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ lang: ja-jp
1616
### アプリを作成する {#create-an-app}
1717
最初にやるべきこと : Bolt での開発を始める前に、[Slack アプリを作成](https://api.slack.com/apps/new)します。
1818

19-
:::tip
20-
21-
通常の業務の妨げにならないよう、別の開発用のワークスペースを使用することをおすすめします。[新しいワークスペースは無料で作成できます](https://slack.com/get-started#create)
19+
:::tip[通常の業務の妨げにならないよう、別の開発用のワークスペースを使用することをおすすめします。[新しいワークスペースは無料で作成できます](https://slack.com/get-started#create)]
2220

2321
:::
2422

@@ -56,9 +54,7 @@ Slack アプリで使用できるトークンには、ユーザートークン
5654

5755
6. 左サイドメニューの「**Socket Mode**」を有効にします。
5856

59-
:::tip
60-
61-
トークンはパスワードと同様に取り扱い、[安全な方法で保管してください](https://docs.slack.dev/authentication/best-practices-for-security)。アプリはこのトークンを使って Slack ワークスペースで投稿をしたり、情報の取得をしたりします。
57+
:::tip[トークンはパスワードと同様に取り扱い、[安全な方法で保管してください](https://docs.slack.dev/authentication/best-practices-for-security)。アプリはこのトークンを使って Slack ワークスペースで投稿をしたり、情報の取得をしたりします。]
6258

6359
:::
6460

@@ -99,9 +95,9 @@ export SLACK_BOT_TOKEN=xoxb-<ボットトークン>
9995
```shell
10096
export SLACK_APP_TOKEN=<アプリレベルトークン>
10197
```
102-
:::warning
98+
:::warning[🔒 全てのトークンは安全に保管してください。]
10399

104-
🔒 全てのトークンは安全に保管してください。少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](https://docs.slack.dev/authentication/best-practices-for-security)のドキュメントを参照してください。
100+
少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](https://docs.slack.dev/authentication/best-practices-for-security)のドキュメントを参照してください。
105101

106102
:::
107103

@@ -359,9 +355,9 @@ if __name__ == "__main__":
359355

360356
ボタンを含む `accessory` オブジェクトでは、`action_id` を指定していることがわかります。これは、ボタンを一意に示す識別子として機能します。これを使って、アプリをどのアクションに応答させるかを指定できます。
361357

362-
:::tip
358+
:::tip[[Block Kit Builder](https://app.slack.com/block-kit-builder) を使用すると、インタラクティブなメッセージのプロトタイプを簡単に作成できます。]
363359

364-
[Block Kit Builder](https://app.slack.com/block-kit-builder) を使用すると、インタラクティブなメッセージのプロトタイプを簡単に作成できます。自分自身やチームメンバーがメッセージのモックアップを作成し、生成される JSON をアプリに直接貼りつけることができます。
360+
自分自身やチームメンバーがメッセージのモックアップを作成し、生成される JSON をアプリに直接貼りつけることができます。
365361

366362
:::
367363

0 commit comments

Comments
 (0)