Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/english/concepts/adding-agent-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The code snippets throughout this guide are from our [Support Agent sample app](
View our [agent quickstart](/ai/agent-quickstart) to get up and running with Casey. Otherwise, read on for exploration and explanation of agent-focused Bolt features found within Casey.
:::

Your agent can utilize features applicable to messages throughout Slack, like [chat streaming](#text-streaming) and [feedback buttons](#adding-and-handling-feedback). They can also [utilize the `Assistant` class](/tools/bolt-python/concepts/assistant-class) for a side-panel view designed with AI in mind.
Your agent can utilize features applicable to messages throughout Slack, like [chat streaming](#text-streaming) and [feedback buttons](#adding-and-handling-feedback). They can also [utilize the `Assistant` class](/tools/bolt-python/concepts/using-the-assistant-class) for a side-panel view designed with AI in mind.

If you're unfamiliar with using these feature within Slack, you may want to read the [API docs on the subject](/ai/). Then come back here to implement them with Bolt!

Expand Down Expand Up @@ -204,7 +204,7 @@ def handle_message(
<TabItem value="assistant" label = "Assistant thread">

:::tip[Using the Assistant side panel]
The Assistant side panel requires additional setup. See the [Assistant class guide](/tools/bolt-python/concepts/assistant-class).
The Assistant side panel requires additional setup. See the [Assistant class guide](/tools/bolt-python/concepts/using-the-assistant-class).
:::


Expand Down
4 changes: 2 additions & 2 deletions docs/english/creating-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ We're going to use bot and app-level tokens for this guide.

:::tip[Not sharing is sometimes caring]

Treat your tokens like passwords and [keep them safe](/security). Your app uses tokens to post and retrieve information from Slack workspaces.
Treat your tokens like passwords and [keep them safe](/concepts/security). Your app uses tokens to post and retrieve information from Slack workspaces.

:::

Expand Down Expand Up @@ -103,7 +103,7 @@ $ export SLACK_APP_TOKEN=<your-app-level-token>

:::warning[Keep it secret. Keep it safe.]

Remember to keep your tokens secure. At a minimum, you should avoid checking them into public version control, and access them via environment variables as we've done above. Check out the API documentation for more on [best practices for app security](/security).
Remember to keep your tokens secure. At a minimum, you should avoid checking them into public version control, and access them via environment variables as we've done above. Check out the API documentation for more on [best practices for app security](/concepts/security).

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/english/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When complete, you'll have a local environment configured with a customized [app

:::tip[Reference for readers]

In search of the complete guide to building an app from scratch? Check out the [building an app](/tools/bolt-python/building-an-app) guide.
In search of the complete guide to building an app from scratch? Check out the [building an app](/tools/bolt-python/creating-an-app) guide.

:::

Expand Down Expand Up @@ -147,7 +147,7 @@ The above command works on Linux and macOS but [similar commands are available o

:::warning[Keep it secret. Keep it safe.]

Treat your tokens like a password and [keep it safe](/security). Your app uses these to retrieve and send information to Slack.
Treat your tokens like a password and [keep it safe](/concepts/security). Your app uses these to retrieve and send information to Slack.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/japanese/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Slack アプリで使用できるトークンには、ユーザートークン

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

:::tip[トークンはパスワードと同様に取り扱い、[安全な方法で保管してください](/security)。アプリはこのトークンを使って Slack ワークスペースで投稿をしたり、情報の取得をしたりします。]
:::tip[トークンはパスワードと同様に取り扱い、[安全な方法で保管してください](/concepts/security)。アプリはこのトークンを使って Slack ワークスペースで投稿をしたり、情報の取得をしたりします。]

:::

Expand Down Expand Up @@ -91,7 +91,7 @@ export SLACK_APP_TOKEN=<アプリレベルトークン>
```
:::warning[🔒 全てのトークンは安全に保管してください。]

少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](/security)のドキュメントを参照してください。
少なくともパブリックなバージョン管理にチェックインするようなことは避けるべきでしょう。また、上にあった例のように環境変数を介してアクセスするようにしてください。詳細な情報は [アプリのセキュリティのベストプラクティス](/concepts/security)のドキュメントを参照してください。

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/app/app.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if __name__ == &#34;__main__&#34;:
app.start(port=int(os.environ.get(&#34;PORT&#34;, 3000)))

Refer to https://docs.slack.dev/tools/bolt-python/building-an-app for details.
Refer to https://docs.slack.dev/tools/bolt-python/creating-an-app for details.

If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth to learn how to configure the app.
Expand Down Expand Up @@ -1438,7 +1438,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if __name__ == "__main__":
app.start(port=int(os.environ.get("PORT", 3000)))
</code></pre>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/building-an-app">https://docs.slack.dev/tools/bolt-python/building-an-app</a> for details.</p>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/creating-an-app">https://docs.slack.dev/tools/bolt-python/creating-an-app</a> for details.</p>
<p>If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to <a href="https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth">https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth</a> to learn how to configure the app.</p>
<h2 id="args">Args</h2>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/app/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if __name__ == &#34;__main__&#34;:
app.start(port=int(os.environ.get(&#34;PORT&#34;, 3000)))

Refer to https://docs.slack.dev/tools/bolt-python/building-an-app for details.
Refer to https://docs.slack.dev/tools/bolt-python/creating-an-app for details.

If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth to learn how to configure the app.
Expand Down Expand Up @@ -1457,7 +1457,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if __name__ == "__main__":
app.start(port=int(os.environ.get("PORT", 3000)))
</code></pre>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/building-an-app">https://docs.slack.dev/tools/bolt-python/building-an-app</a> for details.</p>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/creating-an-app">https://docs.slack.dev/tools/bolt-python/creating-an-app</a> for details.</p>
<p>If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to <a href="https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth">https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth</a> to learn how to configure the app.</p>
<h2 id="args">Args</h2>
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<h1 class="title">Package <code>slack_bolt</code></h1>
</header>
<section id="section-intro">
<p>A Python framework to build Slack apps in a flash with the latest platform features.Read the <a href="https://docs.slack.dev/tools/bolt-python/building-an-app">getting started guide</a> and look at our <a href="https://github.com/slackapi/bolt-python/tree/main/examples">code examples</a> to learn how to build apps using Bolt.</p>
<p>A Python framework to build Slack apps in a flash with the latest platform features.Read the <a href="https://docs.slack.dev/tools/bolt-python/creating-an-app">getting started guide</a> and look at our <a href="https://github.com/slackapi/bolt-python/tree/main/examples">code examples</a> to learn how to build apps using Bolt.</p>
<ul>
<li>Website: <a href="https://docs.slack.dev/tools/bolt-python/">https://docs.slack.dev/tools/bolt-python/</a></li>
<li>GitHub repository: <a href="https://github.com/slackapi/bolt-python">https://github.com/slackapi/bolt-python</a></li>
Expand Down Expand Up @@ -258,7 +258,7 @@ <h3>Class variables</h3>
if __name__ == &#34;__main__&#34;:
app.start(port=int(os.environ.get(&#34;PORT&#34;, 3000)))

Refer to https://docs.slack.dev/tools/bolt-python/building-an-app for details.
Refer to https://docs.slack.dev/tools/bolt-python/creating-an-app for details.

If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth to learn how to configure the app.
Expand Down Expand Up @@ -1578,7 +1578,7 @@ <h3>Class variables</h3>
if __name__ == "__main__":
app.start(port=int(os.environ.get("PORT", 3000)))
</code></pre>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/building-an-app">https://docs.slack.dev/tools/bolt-python/building-an-app</a> for details.</p>
<p>Refer to <a href="https://docs.slack.dev/tools/bolt-python/creating-an-app">https://docs.slack.dev/tools/bolt-python/creating-an-app</a> for details.</p>
<p>If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to <a href="https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth">https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth</a> to learn how to configure the app.</p>
<h2 id="args">Args</h2>
Expand Down
8 changes: 4 additions & 4 deletions examples/aws_lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ Instructions on how to set up and deploy each example are provided below.
- Optionally enter a description for the role, such as "Bolt Python basic
role"
3. Ensure you have created an app on api.slack.com/apps as per the
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
[Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide.
Ensure you have installed it to a workspace.
4. Ensure you have exported your Slack Bot Token and Slack Signing Secret for your
apps as the environment variables `SLACK_BOT_TOKEN` and
`SLACK_SIGNING_SECRET`, respectively, as per the
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
[Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide.
5. You may want to create a dedicated virtual environment for this example app, as
per the "Setting up your project" section of the
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
[Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide.
6. Let's deploy the Lambda! Run `./deploy_lazy.sh`. By default it deploys to the
us-east-1 region in AWS - you can change this at the top of `lazy_aws_lambda_config.yaml` if you wish.
7. Load up AWS Lambda inside the AWS Console - make sure you are in the correct
Expand Down Expand Up @@ -150,7 +150,7 @@ Let’s create a user role that will use the custom policy we created as well as
3. "Create Role"

### Create Slack App and Load your Lambda to AWS
Ensure you have created an app on [api.slack.com/apps](https://api.slack.com/apps) as per the [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide. You do not need to ensure you have installed it to a workspace, as the OAuth flow will provide your app the ability to be installed by anyone.
Ensure you have created an app on [api.slack.com/apps](https://api.slack.com/apps) as per the [Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide. You do not need to ensure you have installed it to a workspace, as the OAuth flow will provide your app the ability to be installed by anyone.

1. Remember those S3 buckets we made? You will need the names of these buckets again in the next step.
2. You need many environment variables exported! Specifically the following from api.slack.com/apps
Expand Down
6 changes: 3 additions & 3 deletions examples/django/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This example demonstrates how you can use Bolt for Python in your Django applica

### `simple_app` - Single-workspace App Example

If you want to run a simple app like the one you've tried in the [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, this is the right one for you. By default, this Django project runs this application. If you want to switch to OAuth flow supported one, modify `myslackapp/urls.py`.
If you want to run a simple app like the one you've tried in the [Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide, this is the right one for you. By default, this Django project runs this application. If you want to switch to OAuth flow supported one, modify `myslackapp/urls.py`.

To run this app, all you need to do are:

Expand All @@ -31,7 +31,7 @@ python manage.py migrate
python manage.py runserver 0.0.0.0:3000
```

As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,
As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,

* Go back to the Slack app configuration page
* Go to "Event Subscriptions"
Expand Down Expand Up @@ -73,7 +73,7 @@ python manage.py migrate
python manage.py runserver 0.0.0.0:3000
```

As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,
As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/creating-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,

* Go back to the Slack app configuration page
* Go to "Event Subscriptions"
Expand Down
4 changes: 2 additions & 2 deletions examples/getting_started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ ngrok http 3000
python3 app.py
```

[1]: https://docs.slack.dev/tools/bolt-python/building-an-app
[1]: https://docs.slack.dev/tools/bolt-python/creating-an-app
[2]: https://docs.slack.dev/tools/bolt-python/
[3]: https://docs.slack.dev/tools/bolt-python/building-an-app#setting-up-events
[3]: https://docs.slack.dev/tools/bolt-python/creating-an-app#setting-up-events
2 changes: 1 addition & 1 deletion slack_bolt/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
A Python framework to build Slack apps in a flash with the latest platform features.Read the [getting started guide](https://docs.slack.dev/tools/bolt-python/building-an-app) and look at our [code examples](https://github.com/slackapi/bolt-python/tree/main/examples) to learn how to build apps using Bolt.
A Python framework to build Slack apps in a flash with the latest platform features.Read the [getting started guide](https://docs.slack.dev/tools/bolt-python/creating-an-app) and look at our [code examples](https://github.com/slackapi/bolt-python/tree/main/examples) to learn how to build apps using Bolt.

* Website: https://docs.slack.dev/tools/bolt-python/
* GitHub repository: https://github.com/slackapi/bolt-python
Expand Down
2 changes: 1 addition & 1 deletion slack_bolt/app/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ def message_hello(message, say):
if __name__ == "__main__":
app.start(port=int(os.environ.get("PORT", 3000)))

Refer to https://docs.slack.dev/tools/bolt-python/building-an-app for details.
Refer to https://docs.slack.dev/tools/bolt-python/creating-an-app for details.

If you would like to build an OAuth app for enabling the app to run with multiple workspaces,
refer to https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth to learn how to configure the app.
Expand Down