Skip to content

Commit 0c1ceb5

Browse files
authored
Docs: new URL (HOLD) (#2024)
2 parents 8274198 + 693fc4e commit 0c1ceb5

File tree

7 files changed

+29
-29
lines changed

7 files changed

+29
-29
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ___
66

77
## Getting Started
88

9-
Visit the [documentation site](https://slack.dev/node-slack-sdk) for all the lovely details.
9+
Visit the [documentation site](https://tools.slack.dev/node-slack-sdk) for all the lovely details.
1010

1111
_This SDK is a collection of single-purpose packages. The packages are aimed at making building Slack apps
1212
easy, performant, secure, and scalable. They can help with just about anything in the Slack platform, from dropping
@@ -21,10 +21,10 @@ walk you through building your first Slack app using Node.js.
2121

2222
| Slack API | What its for | NPM Package |
2323
|--------------|--------------|-------------------|
24-
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://slack.dev/node-slack-sdk/web-api) |
25-
| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://slack.dev/node-slack-sdk/oauth) |
26-
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) |
27-
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://slack.dev/node-slack-sdk/socket-mode) |
24+
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) |
25+
| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) |
26+
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) |
27+
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://tools.slack.dev/node-slack-sdk/socket-mode) |
2828

2929
**Not sure about which APIs are right for your app?** Read our [blog
3030
post](https://medium.com/slack-developer-blog/getting-started-with-slacks-apis-f930c73fc889) that explains the options.
@@ -34,7 +34,7 @@ If you're still not sure, [reach out for help](#getting-help) and our community
3434

3535
`@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed.
3636

37-
At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps.
37+
At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://tools.slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps.
3838

3939
## Installation
4040

@@ -50,7 +50,7 @@ $ yarn add @slack/web-api @slack/socket-mode
5050
## Usage
5151

5252
The following examples summarize the most common ways to use this package. There's also a [Getting Started
53-
tutorial](https://slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
53+
tutorial](https://tools.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
5454
package's documentation, linked in the table above.
5555

5656
### Posting a message with Web API
@@ -88,15 +88,15 @@ where you can prototype your message's look and feel.
8888

8989
### Listening for an event with the Events API
9090

91-
Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#event-listening).
91+
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#event-listening).
9292

9393
### Responding to interactive messages
9494

95-
Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#action-listening).
95+
Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#action-listening).
9696

9797
### Using Socket Mode
9898

99-
Refer to [the module document page](https://slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://slack.dev/bolt-js/concepts#socket-mode).
99+
Refer to [the module document page](https://tools.slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://tools.slack.dev/bolt-js/concepts#socket-mode).
100100

101101
## Requirements
102102

docs/README.md

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

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

docs/content/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ The Node Slack SDK has corresponding packages for Slack APIs. They are small and
1313

1414
| Slack API | Use | NPM package |
1515
|--------------|--------------|-------------------|
16-
| Web API | Send data to or query data from Slack using any of [over 200 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://slack.dev/node-slack-sdk/web-api) |
17-
| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://slack.dev/node-slack-sdk/oauth) |
18-
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) |
19-
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://slack.dev/node-slack-sdk/socket-mode) |
16+
| Web API | Send data to or query data from Slack using any of [over 200 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) |
17+
| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) |
18+
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) |
19+
| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://tools.slack.dev/node-slack-sdk/socket-mode) |
2020

2121
:::warning[Deprecation Notice]
2222

docs/content/packages/rtm-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ app to stay connected to the Slack platform over a persistent Websocket connecti
1010

1111
:::danger
1212

13-
The RTM API isn't available for modern granular-permissions apps, and you can no longer create new legacy apps. We recommend using [Bolt for JavaScript](https://slack.dev/bolt-js). If you have an existing RTM app, do not update its scopes as it will be updated to a granular-permissions app and stop working with the RTM API.
13+
The RTM API isn't available for modern granular-permissions apps, and you can no longer create new legacy apps. We recommend using [Bolt for JavaScript](https://tools.slack.dev/bolt-js). If you have an existing RTM app, do not update its scopes as it will be updated to a granular-permissions app and stop working with the RTM API.
1414

1515
:::
1616

docs/content/packages/socket-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ socketModeClient.on('slash_commands', async ({ body, ack }) => {
5858
});
5959
```
6060

61-
When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://slack.dev/bolt-js/concepts#socket-mode).
61+
When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://tools.slack.dev/bolt-js/concepts#socket-mode).

docs/content/tutorials/local-development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ This tutorial is meant to guide developers through setting up and configuring a
99
Feel free to skip around to the specific sections relevant to you — we won't mind 🙂
1010

1111
## Create an app
12-
Head over to [Create an app](https://slack.dev/bolt-js/getting-started#create-an-app) within our Getting started with JavaScript for Bolt page for instructions on how to create a Slack app on [api.slack.com/apps](https://api.slack.com/apps).
12+
Head over to [Create an app](https://tools.slack.dev/bolt-js/getting-started#create-an-app) within our Getting started with JavaScript for Bolt page for instructions on how to create a Slack app on [api.slack.com/apps](https://api.slack.com/apps).
1313

1414
## Tokens and installing apps
15-
Head over to [Tokens and installing apps](https://slack.dev/bolt-js/getting-started#tokens-and-installing-apps) within our Getting started with JavaScript for Bolt page for information on what tokens are, the [different kinds of tokens available](https://api.slack.com/docs/token-types), how to create them on [api.slack.com/apps](https://api.slack.com/apps), how to install your app to a live Slack workspace and finally how to retrieve your access token.
15+
Head over to [Tokens and installing apps](https://tools.slack.dev/bolt-js/getting-started#tokens-and-installing-apps) within our Getting started with JavaScript for Bolt page for information on what tokens are, the [different kinds of tokens available](https://api.slack.com/docs/token-types), how to create them on [api.slack.com/apps](https://api.slack.com/apps), how to install your app to a live Slack workspace and finally how to retrieve your access token.
1616

1717
## Socket Mode vs. HTTP
1818
Your app can [communicate with Slack using one of two methods](https://api.slack.com/apis/connections):
1919

2020
1. [Socket Mode](https://api.slack.com/apis/connections/socket). Connect to Slack using a direct and long-lived socket connection. This is our recommended approach when getting started in local development because of its convenience. However apps cannot use Socket Mode and also be listed in the [App Directory](https://api.slack.com/start/distributing/directory). For that, you'll need to use [HTTP](#http)). It is also important to remember that Socket Mode is more prone to network faults because the connection is a long-lived one.
21-
2. [HTTP](https://api.slack.com/apis/connections/events-api). Expose your app using a public-facing URL that Slack will send HTTP requests to. This requires a few [additional steps](https://slack.dev/bolt-js/tutorial/getting-started-http#setting-up-events-with-http) to set up, but may be more resilient to network disruptions than communication via Socket Mode.
21+
2. [HTTP](https://api.slack.com/apis/connections/events-api). Expose your app using a public-facing URL that Slack will send HTTP requests to. This requires a few [additional steps](https://tools.slack.dev/bolt-js/tutorial/getting-started-http#setting-up-events-with-http) to set up, but may be more resilient to network disruptions than communication via Socket Mode.
2222

2323
This tutorial will cover how to set up your app using either approach.
2424

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: '/node-slack-sdk/',
1717
organizationName: 'slackapi',
1818
projectName: 'node-slack-sdk',
@@ -178,7 +178,7 @@ const config = {
178178
logo: {
179179
alt: 'Slack logo',
180180
src: 'img/slack-logo.svg',
181-
href: 'https://slack.dev',
181+
href: 'https://tools.slack.dev',
182182
target : '_self'
183183
},
184184
items: [
@@ -189,17 +189,17 @@ const config = {
189189
items: [
190190
{
191191
label: 'Java',
192-
to: 'https://slack.dev/java-slack-sdk/guides/bolt-basics',
192+
to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics',
193193
target: '_self',
194194
},
195195
{
196196
label: 'JavaScript',
197-
to: 'https://slack.dev/bolt-js',
197+
to: 'https://tools.slack.dev/bolt-js',
198198
target: '_self',
199199
},
200200
{
201201
label: 'Python',
202-
to: 'https://slack.dev/bolt-python',
202+
to: 'https://tools.slack.dev/bolt-python',
203203
target: '_self',
204204
},
205205
]
@@ -211,17 +211,17 @@ const config = {
211211
items: [
212212
{
213213
label: 'Java Slack SDK',
214-
to: 'https://slack.dev/java-slack-sdk/',
214+
to: 'https://tools.slack.dev/java-slack-sdk/',
215215
target: '_self',
216216
},
217217
{
218218
label: 'Node Slack SDK',
219-
to: 'https://slack.dev/node-slack-sdk/',
219+
to: 'https://tools.slack.dev/node-slack-sdk/',
220220
target: '_self',
221221
},
222222
{
223223
label: 'Python Slack SDK',
224-
to: 'https://slack.dev/python-slack-sdk/',
224+
to: 'https://tools.slack.dev/python-slack-sdk/',
225225
target: '_self',
226226
},
227227
{
@@ -238,7 +238,7 @@ const config = {
238238
items: [
239239
{
240240
label: 'Community tools',
241-
to: 'https://slack.dev/community-tools',
241+
to: 'https://tools.slack.dev/community-tools',
242242
target: '_self',
243243
},
244244
{

0 commit comments

Comments
 (0)