Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add anchors and add contribute link to sidebar #686

Merged
merged 1 commit into from
Jul 21, 2022
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
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ t:
steps: ワークフローステップ
advanced: 応用コンセプト
start: Bolt 入門ガイド
# contribute: 貢献
contribute: 貢献

# Metadata
repo_name: bolt-python
Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
<li class="title">{{tutorial.title}}</li>
</a>
{% endfor %}
<a href="https://github.com/SlackAPI/bolt-python/blob/master/.github/contributing.md">
<a href="https://github.com/SlackAPI/bolt-python/blob/main/.github/contributing.md">
<li class="title">{{ site.t[page.lang].contribute }}</li>
</a>
</ul>
Expand Down
14 changes: 7 additions & 7 deletions docs/_tutorials/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When you're finished, you'll have this ⚡️[Getting Started with Slack app](ht

---

### Create an app
### Create an app {#create-an-app}
First thing's first: before you start developing with Bolt, you'll want to [create a Slack app](https://api.slack.com/apps/new).

> 💡 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).
Expand All @@ -35,7 +35,7 @@ Look around, add an app icon and description, and then let's start configuring y

---

### Tokens and installing apps
### Tokens and installing apps {#tokens-and-installing-apps}
Slack apps use [OAuth to manage access to Slack's APIs](https://api.slack.com/docs/oauth). When an app is installed, you'll receive a token that the app can use to call API methods.

There are three main token types available to a Slack app: user (`xoxp`), bot (`xoxb`), and app-level (`xapp`) tokens.
Expand Down Expand Up @@ -64,7 +64,7 @@ We're going to use bot and app-level tokens for this guide.

---

### Setting up your project
### Setting up your project {#setting-up-your-project}
With the initial configuration handled, it's time to set up a new Bolt project. This is where you'll write the code that handles the logic for your app.

If you don’t already have a project, let’s create a new one. Create an empty directory:
Expand Down Expand Up @@ -133,7 +133,7 @@ Your app should let you know that it's up and running. 🎉

---

### Setting up events
### Setting up events {#setting-up-events}
Your app behaves similarly to people on your team — it can post messages, add emoji reactions, and listen and respond to events.

To listen for events happening in a Slack workspace (like when a message is posted or when a reaction is posted to a message) you'll use the [Events API to subscribe to event types](https://api.slack.com/events-api).
Expand All @@ -154,7 +154,7 @@ If you want your bot to listen to messages from everywhere it is added to, choos

---

### Listening and responding to a message
### Listening and responding to a message {#listening-and-responding-to-a-message}
Your app is now ready for some logic. Let's start by using the `message()` method to attach a listener for messages.

The following example listens and responds to all messages in channels/DMs where your app has been added that contain the word "hello":
Expand Down Expand Up @@ -186,7 +186,7 @@ This is a basic example, but it gives you a place to start customizing your app

---

### Sending and responding to actions
### Sending and responding to actions {#sending-and-responding-to-actions}

To use features like buttons, select menus, datepickers, modals, and shortcuts, you’ll need to enable interactivity. Head over to **Interactivity & Shortcuts** in your app configuration.

Expand Down Expand Up @@ -288,7 +288,7 @@ You can see that we used `app.action()` to listen for the `action_id` that we na

---

### Next steps
### Next steps {#next-steps}
You just built your first [Bolt for Python app](https://github.com/slackapi/bolt-python/tree/main/examples/getting_started) with Socket Mode! 🎉

Now that you have a basic app up and running, you can start exploring how to make your Bolt app stand out. Here are some ideas about what to explore next:
Expand Down
14 changes: 7 additions & 7 deletions docs/_tutorials/getting_started_http.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When you're finished, you'll have this ⚡️[Getting Started with Slack app](ht

---

### Create an app
### Create an app {#create-an-app}
First thing's first: before you start developing with Bolt, you'll want to [create a Slack app](https://api.slack.com/apps/new).

> 💡 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).
Expand All @@ -33,7 +33,7 @@ Look around, add an app icon and description, and then let's start configuring y

---

### Tokens and installing apps
### Tokens and installing apps {#tokens-and-installing-apps}
Slack apps use [OAuth to manage access to Slack's APIs](https://api.slack.com/docs/oauth). When an app is installed, you'll receive a token that the app can use to call API methods.

There are three main token types available to a Slack app: user (`xoxp`), bot (`xoxb`), and app-level (`xapp`) tokens.
Expand All @@ -57,7 +57,7 @@ For brevity, we're going to use bot tokens for this guide.

---

### Setting up your project
### Setting up your project {#setting-up-your-project}
With the initial configuration handled, it's time to set up a new Bolt project. This is where you'll write the code that handles the logic for your app.

If you don’t already have a project, let’s create a new one. Create an empty directory:
Expand Down Expand Up @@ -127,7 +127,7 @@ Your app should let you know that it's up and running. 🎉

---

### Setting up events over http
### Setting up events over HTTP {#setting-up-events}
Your app behaves similarly to people on your team — it can post messages, add emoji reactions, and listen and respond to events.

To listen for events happening in a Slack workspace (like when a message is posted or when a reaction is posted to a message) you'll use the [Events API to subscribe to event types](https://api.slack.com/events-api).
Expand All @@ -153,7 +153,7 @@ If you want your bot to listen to messages from everywhere it is added to, choos

---

### Listening and responding to a message
### Listening and responding to a message {#listening-and-responding-to-a-message}
Your app is now ready for some logic. Let's start by using the `message()` method to attach a listener for messages.

The following example listens and responds to all messages in channels/DMs where your app has been added that contain the word "hello":
Expand Down Expand Up @@ -187,7 +187,7 @@ This is a basic example, but it gives you a place to start customizing your app

---

### Sending and responding to actions
### Sending and responding to actions {#sending-and-responding-to-actions}

To use features like buttons, select menus, datepickers, modals, and shortcuts, you’ll need to enable interactivity. Similar to events, you'll need to specify a URL for Slack to send the action (such as *user clicked a button*).

Expand Down Expand Up @@ -293,7 +293,7 @@ You can see that we used `app.action()` to listen for the `action_id` that we na

---

### Next steps
### Next steps {#next-steps}
You just built your first [Bolt for Python app](https://github.com/slackapi/bolt-python/tree/main/examples/getting_started)! 🎉

Now that you have a basic app up and running, you can start exploring how to make your Bolt app stand out. Here are some ideas about what to explore next:
Expand Down
20 changes: 10 additions & 10 deletions docs/_tutorials/ja_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ redirect_from:

---

### アプリを作成する
### アプリを作成する {#create-an-app}
最初にやるべきこと : Bolt での開発を始める前に、[Slack アプリを作成](https://api.slack.com/apps/new)します。

> 💡 いつもの仕事のさまたげにならないように、別の開発用のワークスペースを使用することをおすすめします。[新しいワークスペースは無料で作成できます](https://slack.com/get-started#create)。
Expand All @@ -36,7 +36,7 @@ redirect_from:

---

### トークンとアプリのインストール
### トークンとアプリのインストール {#tokens-and-installing-apps}
Slack アプリでは、[Slack API へのアクセスの管理に OAuth を使用します](https://api.slack.com/docs/oauth)。アプリがインストールされると、トークンが発行されます。アプリはそのトークンを使って API メソッドを呼び出すことができます。

Slack アプリで使用できるトークンには、ユーザートークン(`xoxp`)とボットトークン(`xoxb`)、アプリレベルトークン(`xapp`)の 3 種類があります。
Expand Down Expand Up @@ -64,7 +64,7 @@ Slack アプリで使用できるトークンには、ユーザートークン

---

### プロジェクトをセットアップする
### プロジェクトをセットアップする {#setting-up-your-project}
初期設定が終わったら、新しい Bolt プロジェクトのセットアップを行いましょう。このプロジェクトが、あなたのアプリのロジックを処理するコードを配置する場所となります。

プロジェクトをまだ作成していない場合は、新しく作成しましょう。空のディレクトリを作成します。
Expand Down Expand Up @@ -134,7 +134,7 @@ python3 app.py

---

### イベントを設定する
### イベントを設定する {#setting-up-events}
アプリはワークスペース内の他のメンバーと同じように振る舞い、メッセージを投稿したり、絵文字リアクションを追加したり、イベントをリッスンして返答したりできます。

Slack ワークスペースで発生するイベント(メッセージが投稿されたときや、メッセージに対するリアクションがつけられたときなど)をリッスンするには、[Events API を使って特定の種類のイベントをサブスクライブします](https://api.slack.com/events-api)。
Expand All @@ -155,7 +155,7 @@ Slack ワークスペースで発生するイベント(メッセージが投

---

### メッセージをリッスンして応答する
### メッセージをリッスンして応答する {#listening-and-responding-to-a-message}
アプリにロジックを組み込む準備が整いました。まずは `message()` メソッドを使用して、メッセージのリスナーをアタッチしましょう。

次の例では、アプリが参加するチャンネルとダイレクトメッセージに投稿されるすべてのメッセージをリッスンし、「hello」というメッセージに応答を返します。
Expand Down Expand Up @@ -187,7 +187,7 @@ if __name__ == "__main__":

---

### アクションを送信して応答する
### アクションを送信して応答する {#sending-and-responding-to-actions}

インタラクティブ機能を有効にすると、ボタン、選択メニュー、日付ピッカー、モーダル、ショートカットなどの機能が利用できるようになります。アプリ設定ページの「**Interactivity & Shortcuts**」にアクセスしてください。

Expand Down Expand Up @@ -286,12 +286,12 @@ if __name__ == "__main__":

---

### 次のステップ
### 次のステップ {#next-steps}
はじめての [Bolt for Python アプリ](https://github.com/slackapi/bolt-python/tree/main/examples/getting_started)をソケットモードを使って構築することができました。🎉

ここまでで基本的なアプリをセットアップして実行することはできたので、次は自分だけの Bolt アプリを作る方法を調べてみましょう。参考になりそうな記事をいくつかご紹介します。

* [基本的な概念](/bolt-python/concepts#basic)について読んでみてください。Bolt アプリがアクセスできるさまざまメソッドや機能について知ることができます。
* [`events()` メソッド](/bolt-python/concepts#event-listening)でボットがリッスンできるイベントをほかにも試してみましょう。すべてのイベントの一覧は [API サイト](https://api.slack.com/events)で確認できます。
* Bolt では、アプリにアタッチされたクライアントから [Web API メソッドを呼び出す](/bolt-python/concepts#web-api)ことができます。API サイトに [220 以上のメソッド](https://api.slack.com/methods)を一覧しています。
* [基本的な概念](/bolt-python/ja-jp/concepts#basic)について読んでみてください。Bolt アプリがアクセスできるさまざまメソッドや機能について知ることができます。
* [`events()` メソッド](/bolt-python/ja-jp/concepts#event-listening)でボットがリッスンできるイベントをほかにも試してみましょう。すべてのイベントの一覧は [API サイト](https://api.slack.com/events)で確認できます。
* Bolt では、アプリにアタッチされたクライアントから [Web API メソッドを呼び出す](/bolt-python/ja-jp/concepts#web-api)ことができます。API サイトに [220 以上のメソッド](https://api.slack.com/methods)を一覧しています。
* [API サイト](https://api.slack.com/docs/token-types)でほかのタイプのトークンを確認してみてください。アプリで実行したいアクションによって、異なるトークンが必要になる場合があります。ソケットモードを使わないアプリでは、通常はボットトークン (`xoxb`) と署名シークレットが必要です。ソケットモードを使わない場合の例については、 HTTP 方式のやり方としてこのチュートリアルと対になっている [Bolt 入門ガイド(HTTP)](/bolt-python/ja-jp/tutorial/getting-started-http)を参照してください。
20 changes: 10 additions & 10 deletions docs/_tutorials/ja_getting_started_http.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ redirect_from:

---

### アプリを作成する
### アプリを作成する {#create-an-app}
最初にやるべきこと : Bolt での開発を始める前に、[Slack アプリを作成](https://api.slack.com/apps/new)します。

> 💡 いつもの仕事のさまたげにならないように、別の開発用のワークスペースを使用することをおすすめします。[新しいワークスペースは無料で作成できます](https://slack.com/get-started#create)。
Expand All @@ -35,7 +35,7 @@ redirect_from:

---

### トークンとアプリのインストール
### トークンとアプリのインストール {#tokens-and-installing-apps}
Slack アプリでは、[Slack API へのアクセスの管理に OAuth を使用します](https://api.slack.com/docs/oauth)。アプリがインストールされると、トークンが発行されます。アプリはそのトークンを使って API メソッドを呼び出すことができます。

Slack アプリで使用できるトークンには、ユーザートークン(`xoxp`)とボットトークン(`xoxb`)、アプリレベルトークン(`xapp`)の 3 種類があります。
Expand All @@ -59,7 +59,7 @@ Slack アプリで使用できるトークンには、ユーザートークン

---

### プロジェクトをセットアップする
### プロジェクトをセットアップする {#setting-up-your-project}
初期設定が終わったら、新しい Bolt プロジェクトのセットアップを行いましょう。このプロジェクトが、あなたのアプリのロジックを処理するコードを配置する場所となります。

プロジェクトをまだ作成していない場合は、新しく作成しましょう。空のディレクトリを作成します。
Expand Down Expand Up @@ -132,7 +132,7 @@ python3 app.py

---

### HTTPを利用したイベントを設定する
### HTTP を利用したイベントを設定する {#setting-up-events}
アプリはワークスペース内の他のメンバーと同じように振る舞い、メッセージを投稿したり、絵文字リアクションを追加したり、イベントをリッスンして返答したりできます。

Slack ワークスペースで発生するイベント(メッセージが投稿されたときや、メッセージに対するリアクションがつけられたときなど)をリッスンするには、[Events API を使って特定の種類のイベントをサブスクライブします](https://api.slack.com/events-api)。
Expand All @@ -158,7 +158,7 @@ Slack ワークスペースで発生するイベント(メッセージが投

---

### メッセージをリッスンして応答する
### メッセージをリッスンして応答する {#listening-and-responding-to-a-message}
アプリにロジックを組み込む準備が整いました。まずは `message()` メソッドを使用して、メッセージのリスナーをアタッチしましょう。

次の例では、アプリが参加するチャンネルとダイレクトメッセージに投稿されるすべてのメッセージをリッスンし、「hello」というメッセージに応答を返します。
Expand Down Expand Up @@ -192,7 +192,7 @@ if __name__ == "__main__":

---

### アクションを送信して応答する
### アクションを送信して応答する {#sending-and-responding-to-actions}

インタラクティブ機能を有効にすると、ボタン、選択メニュー、日付ピッカー、モーダル、ショートカットなどの機能が利用できるようになります。イベントと同様に、Slack からのアクション(*ユーザーがボタンをクリックした*など)の送信先となる URL を設定する必要があります。

Expand Down Expand Up @@ -299,12 +299,12 @@ if __name__ == "__main__":

---

### 次のステップ
### 次のステップ {#next-steps}
はじめての [Bolt for Python アプリ](https://github.com/slackapi/bolt-python/tree/main/examples/getting_started)を構築することができました。🎉

ここまでで基本的なアプリをセットアップして実行することはできたので、次は自分だけの Bolt アプリを作る方法を調べてみましょう。参考になりそうな記事をいくつかご紹介します。

* [基本的な概念](/bolt-python/concepts#basic)について読む。Bolt アプリがアクセスできるさまざまメソッドや機能について知ることができます。
* [`events()` メソッド](/bolt-python/concepts#event-listening)でボットがリッスンできるイベントをほかにも試してみる。すべてのイベントの一覧は [API サイト](https://api.slack.com/events)で確認できます。
* Bolt では、アプリにアタッチされたクライアントから [Web API メソッドを呼び出す](/bolt-python/concepts#web-api)ことができます。API サイトに [220 以上のメソッド](https://api.slack.com/methods)を一覧しています。
* [基本的な概念](/bolt-python/ja-jp/concepts#basic)について読む。Bolt アプリがアクセスできるさまざまメソッドや機能について知ることができます。
* [`events()` メソッド](/bolt-python/ja-jp/concepts#event-listening)でボットがリッスンできるイベントをほかにも試してみる。すべてのイベントの一覧は [API サイト](https://api.slack.com/events)で確認できます。
* Bolt では、アプリにアタッチされたクライアントから [Web API メソッドを呼び出す](/bolt-python/ja-jp/concepts#web-api)ことができます。API サイトに [220 以上のメソッド](https://api.slack.com/methods)を一覧しています。
* [API サイト](https://api.slack.com/docs/token-types)でほかのタイプのトークンを確認する。アプリで実行したいアクションによって、異なるトークンが必要になる場合があります。HTTPの代わりにソケットモードを利用したい場合には、`connections:write` のスコープを追加した、追加のトークン (`xapp`) が必要です。