Skip to content

Commit e82f6e8

Browse files
docs: new URL (HOLD) (#2253)
Co-authored-by: Steve Gill <[email protected]>
1 parent b4caba0 commit e82f6e8

File tree

12 files changed

+44
-44
lines changed

12 files changed

+44
-44
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![codecov](https://codecov.io/gh/slackapi/bolt-js/branch/main/graph/badge.svg?token=x4oCgiexvp)](https://codecov.io/gh/slackapi/bolt-js)
44
[![Node.js CI](https://github.com/slackapi/bolt-js/actions/workflows/ci-build.yml/badge.svg)](https://github.com/slackapi/bolt-js/actions/workflows/ci-build.yml)
55

6-
A JavaScript framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://slack.dev/bolt-js/tutorial/getting-started) to set-up and run your first Bolt app.
6+
A JavaScript framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://tools.slack.dev/bolt-js/tutorial/getting-started) to set-up and run your first Bolt app.
77

8-
Read [the documentation](https://slack.dev/bolt-js) to explore the basic and advanced concepts of Bolt for JavaScript.
8+
Read [the documentation](https://tools.slack.dev/bolt-js) to explore the basic and advanced concepts of Bolt for JavaScript.
99

1010
## Setup
1111

@@ -80,7 +80,7 @@ Most of the app's functionality will be inside listener functions (the `fn` para
8080

8181
| Argument | Description |
8282
| :---: | :--- |
83-
| `payload` | Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` array. The `payload` object is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangeably. **An easy way to understand what's in a payload is to log it**, or [use TypeScript](https://slack.dev/bolt-js/tutorial/using-typescript). |
83+
| `payload` | Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` array. The `payload` object is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangeably. **An easy way to understand what's in a payload is to log it**, or use TypeScript. |
8484
| `say` | Function to send a message to the channel associated with the incoming event. This argument is only available when the listener is triggered for events that contain a `channel_id` (the most common being `message` events). `say` accepts simple strings (for plain-text messages) and objects (for messages containing blocks). `say` returns a promise that will resolve with a [`chat.postMessage` response](https://api.slack.com/methods/chat.postMessage).
8585
| `ack` | Function that **must** be called to acknowledge that an incoming event was received by your app. `ack` exists for all actions, shortcuts, view, slash command and options requests. `ack` returns a promise that resolves when complete. Read more in [Acknowledging events](#acknowledging-events)
8686
| `client` | Web API client that uses the token associated with that event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by the `authorize` function.
@@ -107,7 +107,7 @@ app.message(async ({ message, say }) => {
107107

108108
### Calling the Web API
109109

110-
In addition to the [`client` property passed to listeners](#making-things-happen), each app has a top-level `client` that can be used to call methods. Unlike the `client` passed to listeners, the top-level client must be passed a `token`. [Read the documentation](https://slack.dev/bolt-js/concepts#web-api) for more details.
110+
In addition to the [`client` property passed to listeners](#making-things-happen), each app has a top-level `client` that can be used to call methods. Unlike the `client` passed to listeners, the top-level client must be passed a `token`. [Read the documentation](https://tools.slack.dev/bolt-js/concepts#web-api) for more details.
111111

112112
### Acknowledging events
113113

@@ -129,7 +129,7 @@ Depending on the type of incoming event a listener is meant for, `ack()` should
129129

130130
## Getting Help
131131

132-
[The documentation](https://slack.dev/bolt-js) has more information on basic and advanced concepts for Bolt for JavaScript.
132+
[The documentation](https://tools.slack.dev/bolt-js) has more information on basic and advanced concepts for Bolt for JavaScript.
133133

134134
If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
135135

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# slack.dev/bolt-js
1+
# tools.slack.dev/bolt-js
22

33
This website is built using [Docusaurus](https://docusaurus.io/). 'Tis cool.
44

docs/content/basic/authenticating-oauth.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -702,30 +702,30 @@ for additional details for common error codes.
702702
[authorization]: /concepts/authorization
703703
[callback-default-failure]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L127-L162
704704
[callback-default-success]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L81-L125
705-
[callback-options]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions
705+
[callback-options]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions
706706
[callback-options-default]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L81-L162
707-
[callbacks]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions
707+
[callbacks]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions
708708
[custom-routes]: /concepts/custom-routes
709709
[direct-install]: https://github.com/slackapi/bolt-js/blob/5b4d9ceb65e6bf5cf29dfa58268ea248e5466bfb/examples/oauth/app.js#L58-L64
710710
[errors]: https://api.slack.com/authentication/oauth-v2#errors
711711
[examples]: https://github.com/slackapi/bolt-js/tree/main/examples/oauth
712-
[generate-install-url]: https://slack.dev/node-slack-sdk/oauth/#using-handleinstallpath
712+
[generate-install-url]: https://tools.slack.dev/node-slack-sdk/oauth/#using-handleinstallpath
713713
[install-provider-options]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts
714-
[installation-page]: https://slack.dev/node-slack-sdk/oauth/#showing-an-installation-page
715-
[installation-store]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/InstallationStore
714+
[installation-page]: https://tools.slack.dev/node-slack-sdk/oauth/#showing-an-installation-page
715+
[installation-store]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/InstallationStore
716716
[installation-store-file]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts
717-
[oauth-node]: https://slack.dev/node-slack-sdk/oauth
717+
[oauth-node]: https://tools.slack.dev/node-slack-sdk/oauth
718718
[oauth-v2]: https://api.slack.com/authentication/oauth-v2
719-
[oidc]: https://slack.dev/node-slack-sdk/web-api#sign-in-with-slack-via-openid-connect
719+
[oidc]: https://tools.slack.dev/node-slack-sdk/web-api#sign-in-with-slack-via-openid-connect
720720
[org-ready]: https://api.slack.com/enterprise/org-ready-apps
721721
[org-ready-oauth]: https://api.slack.com/enterprise/org-ready-apps#oauth
722722
[scopes]: https://api.slack.com/scopes
723723
[settings]: https://api.slack.com/apps
724724
[siws]: https://api.slack.com/authentication/sign-in-with-slack
725-
[state]: https://slack.dev/node-slack-sdk/oauth#using-a-custom-state-store
726-
[state-store]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/StateStore
725+
[state]: https://tools.slack.dev/node-slack-sdk/oauth#using-a-custom-state-store
726+
[state-store]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/StateStore
727727
[state-store-clear]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts
728-
[store]: https://slack.dev/node-slack-sdk/oauth#storing-installations-in-a-database
728+
[store]: https://tools.slack.dev/node-slack-sdk/oauth#storing-installations-in-a-database
729729
[user-tokens]: https://api.slack.com/concepts/token-types#user
730-
[verification]: https://slack.dev/node-slack-sdk/oauth#state-verification
731-
[web-api]: https://slack.dev/node-slack-sdk/web-api
730+
[verification]: https://tools.slack.dev/node-slack-sdk/oauth#state-verification
731+
[web-api]: https://tools.slack.dev/node-slack-sdk/web-api

docs/content/basic/web-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ lang: en
44
slug: /concepts/web-api
55
---
66

7-
You can call [any Web API method](https://api.slack.com/methods) using the [`WebClient`](https://slack.dev/node-slack-sdk/web-api) provided to your app's listeners as `client`. This uses either the token that initialized your app **or** the token that is returned from the [`authorize`](/concepts/authorization) function for the incoming event. The built-in [OAuth support](/concepts/authenticating-oauth) handles the second case by default.
7+
You can call [any Web API method](https://api.slack.com/methods) using the [`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api) provided to your app's listeners as `client`. This uses either the token that initialized your app **or** the token that is returned from the [`authorize`](/concepts/authorization) function for the incoming event. The built-in [OAuth support](/concepts/authenticating-oauth) handles the second case by default.
88

99
Your Bolt app also has a top-level `app.client` which you can manually pass the `token` parameter. If the incoming request is not authorized or you're calling a method from outside of a listener, use the top-level `app.client`.
1010

11-
Calling one of the [`WebClient`](https://slack.dev/node-slack-sdk/web-api)'s methods will return a Promise containing the response from Slack, regardless of whether you use the top-level or listener's client.
11+
Calling one of the [`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api)'s methods will return a Promise containing the response from Slack, regardless of whether you use the top-level or listener's client.
1212

1313
Since the introduction of [org wide app installations](https://api.slack.com/enterprise/apps), [some web-api methods](https://api.slack.com/enterprise/apps/changes-apis#methods) now require `team_id` to indicate which workspace to act on. Bolt for JavaScript will attempt to infer the `team_id` based on incoming payloads and pass it along to `client`. This is handy for existing applications looking to add support for org wide installations and not spend time updating all of these web-api calls.
1414

docs/content/reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ App options are passed into the `App` constructor. When the `receiver` argument
128128
| Option | Description |
129129
| :--- | :--- |
130130
| `receiver` | An instance of `Receiver` that parses and handles incoming events. Must conform to the [`Receiver` interface](/concepts/receiver), which includes `init(app)`, `start()`, and `stop()`. More information about receivers is [in the documentation](/concepts/receiver). |
131-
| `agent` | Optional HTTP `Agent` used to set up proxy support. Read more about custom agents in the [Node Slack SDK documentation](https://slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent). |
131+
| `agent` | Optional HTTP `Agent` used to set up proxy support. Read more about custom agents in the [Node Slack SDK documentation](https://tools.slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent). |
132132
| `clientTls` | Optional `string` to set a custom TLS configuration for HTTP client requests. Must be one of: `"pfx"`, `"key"`, `"passphrase"`, `"cert"`, or `"ca"`. |
133133
| `convoStore` | A store to set and retrieve state-related conversation information. `set()` sets conversation state and `get()` fetches it. By default, apps have access to an in-memory store. More information and an example can be found [in the documentation](/concepts/conversation-store). |
134134
| `token` | A `string` from your app's configuration (under "Settings" > "Install App") required for calling the Web API. May not be passed when using `authorize`, `orgAuthorize`, or OAuth. |
@@ -147,7 +147,7 @@ App options are passed into the `App` constructor. When the `receiver` argument
147147

148148
:::info
149149

150-
Bolt's client is an instance of `WebClient` from the [Node Slack SDK](https://slack.dev/node-slack-sdk), so some of that documentation may be helpful as you're developing.
150+
Bolt's client is an instance of `WebClient` from the [Node Slack SDK](https://tools.slack.dev/node-slack-sdk), so some of that documentation may be helpful as you're developing.
151151

152152
:::
153153

@@ -172,11 +172,11 @@ You can find the code for error definition and construction within [errors.ts](h
172172
:::
173173

174174
### Client errors
175-
Bolt imports a `WebClient` to call Slack's APIs. Below is a set of errors you may encounter when making API calls with the client, though you can read more [in the web API documentation](https://slack.dev/node-slack-sdk/web-api#handle-errors). When handling client errors, more information can be found in the body within the `data` property.
175+
Bolt imports a `WebClient` to call Slack's APIs. Below is a set of errors you may encounter when making API calls with the client, though you can read more [in the web API documentation](https://tools.slack.dev/node-slack-sdk/web-api#handle-errors). When handling client errors, more information can be found in the body within the `data` property.
176176

177177
| Error code | Details |
178178
| :--- | :--- |
179179
| `PlatformError` | Error received when calling a Slack API. Includes a `data` property. |
180180
| `RequestError` | A request could not be sent, perhaps because your network connection is not available. It has an `original` property with more details. |
181-
| `RateLimitedError` | Your app has made too many requests too quickly. Includes a `retryAfter` property with the number of seconds you should wait before trying to send again. The `WebClient` will handle rate limit errors by default–[you can read more in the documentation](https://slack.dev/node-slack-sdk/web-api#rate-limits). |
181+
| `RateLimitedError` | Your app has made too many requests too quickly. Includes a `retryAfter` property with the number of seconds you should wait before trying to send again. The `WebClient` will handle rate limit errors by default–[you can read more in the documentation](https://tools.slack.dev/node-slack-sdk/web-api#rate-limits). |
182182
| `HTTPError` | The HTTP response contained an unfamiliar status code. The Web API only responds with `200` (including for errors), or `429` for rate limiting. |

docs/content/tutorial/hubot-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The [Events API](https://api.slack.com/bot-users#app-mentions-response) is a bot
5353

5454
:::info
5555

56-
Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/getting-started) and [setting up events](https://slack.dev/getting-started#setting-up-events) in the Getting Started guide.
56+
Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/getting-started) and [setting up events](https://tools.slack.dev/getting-started#setting-up-events) in the Getting Started guide.
5757

5858
:::
5959

docs/docusaurus.config.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const config = {
1212
tagline: 'Official frameworks, libraries, and SDKs for Slack developers',
1313
favicon: 'img/favicon.ico',
1414

15-
url: 'https://slack.dev',
15+
url: 'https://tools.slack.dev',
1616
baseUrl: '/bolt-js/',
1717
organizationName: 'slackapi',
1818
projectName: 'bolt-js',
@@ -86,7 +86,7 @@ plugins:
8686
logo: {
8787
alt: 'Slack logo',
8888
src: 'img/slack-logo.svg',
89-
href: 'https://slack.dev',
89+
href: 'https://tools.slack.dev',
9090
target : '_self'
9191
},
9292
items: [
@@ -97,17 +97,17 @@ plugins:
9797
items: [
9898
{
9999
label: 'Java',
100-
to: 'https://slack.dev/java-slack-sdk/guides/bolt-basics',
100+
to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics',
101101
target: '_self',
102102
},
103103
{
104104
label: 'JavaScript',
105-
to: 'https://slack.dev/bolt-js',
105+
to: 'https://tools.slack.dev/bolt-js',
106106
target: '_self',
107107
},
108108
{
109109
label: 'Python',
110-
to: 'https://slack.dev/bolt-python',
110+
to: 'https://tools.slack.dev/bolt-python',
111111
target: '_self',
112112
},
113113
]
@@ -119,17 +119,17 @@ plugins:
119119
items: [
120120
{
121121
label: 'Java Slack SDK',
122-
to: 'https://slack.dev/java-slack-sdk/',
122+
to: 'https://tools.slack.dev/java-slack-sdk/',
123123
target: '_self',
124124
},
125125
{
126126
label: 'Node Slack SDK',
127-
to: 'https://slack.dev/node-slack-sdk/',
127+
to: 'https://tools.slack.dev/node-slack-sdk/',
128128
target: '_self',
129129
},
130130
{
131131
label: 'Python Slack SDK',
132-
to: 'https://slack.dev/python-slack-sdk/',
132+
to: 'https://tools.slack.dev/python-slack-sdk/',
133133
target: '_self',
134134
},
135135
{
@@ -146,7 +146,7 @@ plugins:
146146
items: [
147147
{
148148
label: 'Community tools',
149-
to: 'https://slack.dev/community-tools',
149+
to: 'https://tools.slack.dev/community-tools',
150150
target: '_self',
151151
},
152152
{

docs/i18n/ja-jp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,4 +118,4 @@ For example:
118118
},
119119
```
120120

121-
Be careful changing `code.json`. If you change something in this repo, it will likely need to be changed in the other Slack.dev repos too, like the Bolt-Python repo. We want these translations to match for all Slack.dev sites.
121+
Be careful changing `code.json`. If you change something in this repo, it will likely need to be changed in the other tools.slack.dev repos too, like the Bolt-Python repo. We want these translations to match for all tools.slack.dev sites.

0 commit comments

Comments
 (0)