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

Updates links and adds anchors in JP and EN docs #1526

Merged
merged 2 commits 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/_deployments/aws-lambda.md
Expand Up @@ -16,7 +16,7 @@ When you’re finished, you’ll have this ⚡️[Deploying to AWS Lambda app][d

---

### Set up AWS Lambda
### Set up AWS Lambda {#set-up-aws-lambda}

[AWS Lambda][aws-lambda] is a serverless, Function-as-a-Service (FaaS) platform that allows you to run code without managing servers. In this section, we'll configure your local machine to access AWS Lambda.

Expand Down Expand Up @@ -62,7 +62,7 @@ That wraps up configuring your local machine to access AWS. 👏 Next, let's do

---

### Set up Serverless Framework
### Set up Serverless Framework {#set-up-serverless-framework}

The [Serverless Framework][serverless-framework] includes tools that let you easily configure, debug, and deploy your app to AWS Lambda.

Expand All @@ -80,7 +80,7 @@ You're now set up with the Serverless tools! Let's move on to preparing your Bol

---

### Get a Bolt Slack app
### Get a Bolt Slack app {#get-a-bolt-slack-app}

If you haven't already built your own Bolt app, you can use our [Getting Started guide][getting-started-guide] or clone the template app below:

Expand All @@ -98,7 +98,7 @@ Now that you have an app, let's prepare it for AWS Lambda and the Serverless Fra

---

### Prepare the app
### Prepare the app {#prepare-the-app}

**1. Prepare the app for AWS Lambda**

Expand Down Expand Up @@ -202,7 +202,7 @@ Congratulations, you've just prepared your Bolt app for AWS Lambda and Serverles

---

### Run the app locally
### Run the app locally {#run-the-app-locally}

Now that your app is configured to respond to an AWS Lambda function, we'll set up your environment to run the app locally.

Expand Down Expand Up @@ -252,7 +252,7 @@ If you don’t receive a response, check your **Request URL** and try again.

---

### Deploy the app
### Deploy the app {#deploy-the-app}

In the previous section of this tutorial, you ran your app locally and tested it in a live Slack workspace. Now that you have a working app, let's deploy it!

Expand Down Expand Up @@ -323,7 +323,7 @@ When the deploy is complete, you can open a Slack channel that your app has join

---

### Next steps
### Next steps {#next-steps}

You just deployed your first ⚡️[Bolt for JavaScript app to AWS Lambda][deploy-aws-lambda-app]! 🚀

Expand Down
14 changes: 7 additions & 7 deletions docs/_deployments/heroku.md
Expand Up @@ -16,7 +16,7 @@ When you’re finished, you’ll have this ⚡️[Deploying to Heroku app][deplo

---

### Get a Bolt Slack app
### Get a Bolt Slack app {#get-a-bolt-slack-app}

If you haven't already built your own Bolt app, you can use our [Getting Started guide][getting-started-guide] or clone the template app below:

Expand All @@ -34,7 +34,7 @@ Now that you have an app, let's prepare it for Heroku.

---

### Prepare the app for Heroku
### Prepare the app for Heroku {#prepare-the-app-for-heroku}

Heroku is a flexible platform that requires some configuration to host your app. In this section, we'll update your Bolt app to support Heroku.

Expand Down Expand Up @@ -73,7 +73,7 @@ git commit -m "Add Procfile"

---

### Set up the Heroku tools
### Set up the Heroku tools {#set-up-the-heroku-tools}

Now we can set up the Heroku tools on your local machine. These tools will help you manage, deploy, and debug your app on Heroku's platform.

Expand Down Expand Up @@ -114,7 +114,7 @@ You should now be set up with the Heroku tools! Let's move on to the exciting st

---

### Create an app on Heroku
### Create an app on Heroku {#create-an-app-on-heroku}

It’s time to [create a Heroku app](https://devcenter.heroku.com/articles/creating-apps) using the tools that you just installed. When you create an app, you can choose a unique name or have it randomly generated.

Expand Down Expand Up @@ -167,7 +167,7 @@ Now that we have prepared your local app and created a Heroku app, the next step

---

### Deploy the app
### Deploy the app {#deploy-the-app}

To deploy the app, we're going to push your local code to Heroku, update your Slack app's settings, and say "hello" to your Heroku app. ✨

Expand Down Expand Up @@ -225,7 +225,7 @@ Open a Slack channel that your app has joined and say "hello" (lower-case). Just

---

### Deploy an update
### Deploy an update {#deploy-an-update}

As you continue building your Slack app, you'll need to deploy updates. A common flow is to make a change, commit it, and then push it to Heroku.

Expand Down Expand Up @@ -255,7 +255,7 @@ When the deploy is complete, you can open a Slack channel that your app has join

---

### Next steps
### Next steps {#next-steps}

You just deployed your first ⚡️[Bolt for JavaScript app to Heroku][deploy-heroku-app]! 🚀

Expand Down
26 changes: 13 additions & 13 deletions docs/_deployments/ja_aws-lambda.md
Expand Up @@ -16,7 +16,7 @@ permalink: /ja-jp/deployments/aws-lambda

---

### AWS Lambda のセットアップ
### AWS Lambda のセットアップ {#set-up-aws-lambda}

[AWS Lambda][aws-lambda] はサーバーレスの Function-as-a-Service(FaaS)プラットフォームです。AWS Lambda を利用すると、サーバーを管理することなく、コードを実行することができます。このセクションでは、ローカルマシンから AWS Lambda にアクセスするための設定を行います。

Expand Down Expand Up @@ -62,7 +62,7 @@ aws configure

---

### Serverless Framework をセットアップする
### Serverless Framework をセットアップする {#set-up-serverless-framework}

[Serverless Framework][serverless-framework] では、AWS Lambda 向けのアプリの設定、デバッグ、デプロイを簡単に行うためのツールが用意されています。

Expand All @@ -80,7 +80,7 @@ Serverless のツールのセットアップが完了しました。次に、AWS

---

### Bolt Slack アプリを入手する
### Bolt Slack アプリを入手する {#get-a-bolt-slack-app}

まだ Bolt アプリを自分で作成したことがない場合は、[入門ガイド][getting-started-guide]を参照してください。テンプレートのアプリをクローンするには、以下のコマンドを実行します。

Expand All @@ -98,7 +98,7 @@ Bolt アプリを用意できました。次に AWS Lambda と Serverless Framew

---

### アプリをセットアップする
### アプリをセットアップする {#prepare-the-app}

**1. アプリを AWS Lambda に対応させる**

Expand All @@ -113,7 +113,7 @@ const app = new App({
});
```

次に Lambda 関数のイベントに応答するよう、Bolt アプリの [`receiver`](https://slack.dev/bolt-js/ja-jp/concepts#receiver) をカスタマイズします。
次に Lambda 関数のイベントに応答するよう、Bolt アプリの [`receiver`](/bolt-js/ja-jp/concepts#receiver) をカスタマイズします。

`app.js` のソースコードの中で[モジュールのインポートを行う部分](https://github.com/slackapi/bolt-js-getting-started-app/blob/main/app.js#L1)を編集し、Bolt の `AwsLambdaReceiver` モジュールを require します。

Expand Down Expand Up @@ -184,7 +184,7 @@ plugins:
- serverless-offline
```

> 💡 `SLACK_SIGNING_SECRET` と `SLACK_BOT_TOKEN` の環境変数は、ローカルマシンで設定しておく必要があります。[Slack の環境変数をエクスポートする方法](/bolt-js/tutorial/getting-started#setting-up-your-project)を入門ガイドで参照してください。
> 💡 `SLACK_SIGNING_SECRET` と `SLACK_BOT_TOKEN` の環境変数は、ローカルマシンで設定しておく必要があります。[Slack の環境変数をエクスポートする方法](/bolt-js/ja-jp/tutorial/getting-started#setting-up-your-project)を入門ガイドで参照してください。

**3. serverless-offline モジュールをインストールする**

Expand All @@ -200,7 +200,7 @@ npm install --save-dev serverless-offline

---

### アプリをローカルで実行する
### アプリをローカルで実行する {#run-the-app-locally}

アプリを AWS Lambda 関数に応答させるための準備が完了したので、次にローカルでアプリを実行できるように環境を設定します。

Expand Down Expand Up @@ -248,7 +248,7 @@ Slack アプリをテストします。今作った Bolt アプリを Slack の

---

### アプリをデプロイする
### アプリをデプロイする {#deploy-the-app}

今までローカルでアプリを実行し、 Slack ワークスペースでテストをしてきました。さて、動作するアプリができたので、デプロイしてみましょう!

Expand Down Expand Up @@ -318,15 +318,15 @@ serverless deploy

---

### 次のステップ
### 次のステップ {#next-steps}

⚡️[AWS Lambda を使った最初の Bolt for JavaScript アプリ][deploy-aws-lambda-app]をデプロイできました。🚀

基本的なアプリのデプロイができましたので、次はアプリのカスタマイズやモニタリングを行う方法を調べてみましょう。

- [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) と [Serverless Framework](https://www.serverless.com/framework/docs/providers/aws/guide/intro/) の理解を深める。
- [Bolt の基本的な概念](/bolt-js/concepts#basic)と [Serverless のプラグイン](https://www.serverless.com/framework/docs/providers/aws/guide/plugins/)を活用してアプリを拡張する。
- [Bolt の応用コンセプト](/bolt-js/concepts#logging)でログの記録についての知識を深めたり、[Serverless でのログメッセージの表示方法](https://www.serverless.com/framework/docs/providers/aws/cli-reference/logs/)について確認したりする。
- [Bolt の基本的な概念](/bolt-js/ja-jp/concepts#basic)と [Serverless のプラグイン](https://www.serverless.com/framework/docs/providers/aws/guide/plugins/)を活用してアプリを拡張する。
- [Bolt の応用コンセプト](/bolt-js/ja-jp/concepts#logging)でログの記録についての知識を深めたり、[Serverless でのログメッセージの表示方法](https://www.serverless.com/framework/docs/providers/aws/cli-reference/logs/)について確認したりする。
- Serverless の [AWS Lambda のテスト環境](https://www.serverless.com/framework/docs/providers/aws/guide/testing/)や[デプロイ環境](https://www.serverless.com/framework/docs/providers/aws/guide/deploying/)を本格的に活用する。

[aws-cli-configure]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config
Expand All @@ -341,6 +341,6 @@ serverless deploy
[bolt-js]: /bolt-js
[deploy-aws-lambda-app]: https://github.com/slackapi/bolt-js/tree/main/examples/deploy-aws-lambda
[deploy-aws-lambda-app/app.js]: https://github.com/slackapi/bolt-js/tree/main/examples/deploy-aws-lambda/app.js
[getting-started-guide-setting-up-events]: https://slack.dev/bolt-js/tutorial/getting-started#setting-up-events
[getting-started-guide]: /bolt-js/tutorial/getting-started
[getting-started-guide-setting-up-events]: https://slack.dev/bolt-js/ja-jp/tutorial/getting-started#setting-up-events
[getting-started-guide]: /bolt-js/ja-jp/tutorial/getting-started
[serverless-framework]: https://serverless.com/
14 changes: 7 additions & 7 deletions docs/_deployments/ja_heroku.md
Expand Up @@ -16,7 +16,7 @@ permalink: /ja-jp/deployments/heroku

---

### Bolt Slack アプリを入手する
### Bolt Slack アプリを入手する {#get-a-bolt-slack-app}

Bolt アプリを作るのが初めてという場合は、まず[Bolt 入門ガイド][getting-started-guide]に沿って進めてみましょう。または、以下のテンプレートアプリをクローンしてもよいでしょう。

Expand All @@ -34,7 +34,7 @@ cd bolt-js-getting-started-app/

---

### アプリをHeroku で動かすための準備する
### アプリをHeroku で動かすための準備する {#prepare-the-app-for-heroku}

Heroku は、作ったアプリをホストできる柔軟性の高いプラットフォームで、少し設定が必要です。このセクションでは、Bolt アプリに変更を加え、Heroku に対応させます。

Expand Down Expand Up @@ -73,7 +73,7 @@ git commit -m "Add Procfile"

---

### Heroku ツールをセットアップする
### Heroku ツールをセットアップする {#set-up-the-heroku-tools}

ローカルマシンでHeroku ツールのセットアップを行います。このツールは、Heroku プラットフォームを使用するアプリの管理、デプロイ、デバッグを行う場合に便利です。

Expand Down Expand Up @@ -114,7 +114,7 @@ heroku auth:whoami

---

### Heroku アプリを作成する
### Heroku アプリを作成する {#create-an-app-on-heroku}

先ほどインストールしたツールを使って、[Heroku アプリを作成](https://devcenter.heroku.com/articles/creating-apps)します。アプリを作成するときは、ユニークな名前を自分で指定するか、ランダムな名前を生成することができます。

Expand Down Expand Up @@ -168,7 +168,7 @@ heroku config:set SLACK_BOT_TOKEN=xoxb-<your-bot-token>

---

### アプリをデプロイする
### アプリをデプロイする {#deploy-the-app}

アプリをデプロイするため、ローカルのコードをHeroku にプッシュします。その後Slack アプリの設定を更新し、Heroku アプリに"hello" と声をかけてみましょう。 ✨

Expand Down Expand Up @@ -227,7 +227,7 @@ heroku info

---

### 変更をデプロイする
### 変更をデプロイする {#deploy-an-update}

Slack アプリを構築するなかで、変更を加えてデプロイする必要があります。一般的な流れでは、変更を加え、コミットし、Heroku にプッシュするという順番です。

Expand Down Expand Up @@ -257,7 +257,7 @@ git push heroku main

---

### 次のステップ
### 次のステップ {#next-steps}

これではじめて️⚡Bolt for JavaScript アプリをHerokuへデプロイすることに成功しました。🚀

Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/sidebar.html
Expand Up @@ -84,7 +84,7 @@
<li class="title">{{tutorial.title}}</li>
</a>
{% endfor %}
<a href="https://github.com/SlackAPI/bolt-js/blob/master/.github/contributing.md">
<a href="https://github.com/SlackAPI/bolt-js/blob/main/.github/contributing.md">
<li class="title">{{ site.t[page.lang].contribute }}</li>
</a>
</ul>
Expand Down
16 changes: 8 additions & 8 deletions docs/_tutorials/getting_started.md
Expand Up @@ -18,7 +18,7 @@ When you’re finished, you’ll have this ⚡️[Getting Started app](https://g

---

### 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 (`xapp`) tokens.
Expand All @@ -57,7 +57,7 @@ We're going to use bot and app 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 and initialize a new project:
Expand Down Expand Up @@ -120,12 +120,12 @@ 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). For this guide, we are going to be using [Socket Mode](https://api.slack.com/apis/connections/socket), our recommended option for those just getting started and building something for their team.

> 💡 Socket Mode lets apps use the Events API and interactive components without exposing a public HTTP endpoint. This can be helpful during development, or if you're receiving requests from behind a firewall. HTTP is more useful for apps being deployed to hosting environments (like [AWS](/bolt-js/deployments/aws-lambda) or [Heroku](/bolt-js/deployments/heroku)), or apps intended for distribution via the Slack App Directory. To continue this setting up guide with HTTP, head over [here](/bolt-js/tutorial/getting-started-http#setting-up-events).
> 💡 Socket Mode lets apps use the Events API and interactive components without exposing a public HTTP endpoint. This can be helpful during development, or if you're receiving requests from behind a firewall. HTTP is more useful for apps being deployed to hosting environments (like [AWS](/bolt-js/deployments/aws-lambda) or [Heroku](/bolt-js/deployments/heroku)), or apps intended for distribution via the Slack App Directory. To continue this setting up guide with HTTP, head over [here](/bolt-js/tutorial/getting-started-http#setting-up-events-with-http).

Okay, let's enable Socket Mode:

Expand Down Expand Up @@ -164,7 +164,7 @@ const app = new App({
```

---
### 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 @@ -202,7 +202,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 @@ -328,7 +328,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 JavaScript app](https://github.com/slackapi/bolt-js-getting-started-app) 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