diff --git a/README.md b/README.md index b5e460b05..5948bde34 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ___ ## Getting Started -Visit the [documentation site](https://slack.dev/node-slack-sdk) for all the lovely details. +Visit the [documentation site](https://tools.slack.dev/node-slack-sdk) for all the lovely details. _This SDK is a collection of single-purpose packages. The packages are aimed at making building Slack apps 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. | Slack API | What its for | NPM Package | |--------------|--------------|-------------------| -| 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) | -| 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) | -| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) | -| 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) | +| 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) | +| 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) | +| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) | +| 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) | **Not sure about which APIs are right for your app?** Read our [blog 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 `@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. -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. +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. ## Installation @@ -50,7 +50,7 @@ $ yarn add @slack/web-api @slack/socket-mode ## Usage The following examples summarize the most common ways to use this package. There's also a [Getting Started -tutorial](https://slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each +tutorial](https://tools.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each package's documentation, linked in the table above. ### Posting a message with Web API @@ -88,15 +88,15 @@ where you can prototype your message's look and feel. ### Listening for an event with the Events API -Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#event-listening). +Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#event-listening). ### Responding to interactive messages -Refer to [Bolt for JavaScript document pages](https://slack.dev/bolt-js/concepts#action-listening). +Refer to [Bolt for JavaScript document pages](https://tools.slack.dev/bolt-js/concepts#action-listening). ### Using Socket Mode -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). +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). ## Requirements diff --git a/docs/README.md b/docs/README.md index 7b63722e4..b7c72a3a7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# slack.dev +# tools.slack.dev This website is built using [Docusaurus](https://docusaurus.io/). 'Tis cool. diff --git a/docs/content/index.md b/docs/content/index.md index 26b51e900..22e2b4f90 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -13,10 +13,10 @@ The Node Slack SDK has corresponding packages for Slack APIs. They are small and | Slack API | Use | NPM package | |--------------|--------------|-------------------| -| 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) | -| 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) | -| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) | -| 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) | +| 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) | +| 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) | +| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) | +| 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) | :::warning[Deprecation Notice] diff --git a/docs/content/packages/rtm-api.md b/docs/content/packages/rtm-api.md index ffc5e869a..9449fe59e 100644 --- a/docs/content/packages/rtm-api.md +++ b/docs/content/packages/rtm-api.md @@ -10,7 +10,7 @@ app to stay connected to the Slack platform over a persistent Websocket connecti :::danger -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. +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. ::: diff --git a/docs/content/packages/socket-mode.md b/docs/content/packages/socket-mode.md index a7a3b31ff..e09331620 100644 --- a/docs/content/packages/socket-mode.md +++ b/docs/content/packages/socket-mode.md @@ -58,4 +58,4 @@ socketModeClient.on('slash_commands', async ({ body, ack }) => { }); ``` -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). +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). diff --git a/docs/content/tutorials/local-development.md b/docs/content/tutorials/local-development.md index a40e14852..4fa6f4a88 100644 --- a/docs/content/tutorials/local-development.md +++ b/docs/content/tutorials/local-development.md @@ -9,16 +9,16 @@ This tutorial is meant to guide developers through setting up and configuring a Feel free to skip around to the specific sections relevant to you — we won't mind 🙂 ## Create an app -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). +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). ## Tokens and installing apps -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. +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. ## Socket Mode vs. HTTP Your app can [communicate with Slack using one of two methods](https://api.slack.com/apis/connections): 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. -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. +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. This tutorial will cover how to set up your app using either approach. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 938b81aaf..33dce351f 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -12,7 +12,7 @@ const config = { tagline: 'Official frameworks, libraries, and SDKs for Slack developers', favicon: 'img/favicon.ico', - url: 'https://slack.dev', + url: 'https://tools.slack.dev', baseUrl: '/node-slack-sdk/', organizationName: 'slackapi', projectName: 'node-slack-sdk', @@ -178,7 +178,7 @@ const config = { logo: { alt: 'Slack logo', src: 'img/slack-logo.svg', - href: 'https://slack.dev', + href: 'https://tools.slack.dev', target : '_self' }, items: [ @@ -189,17 +189,17 @@ const config = { items: [ { label: 'Java', - to: 'https://slack.dev/java-slack-sdk/guides/bolt-basics', + to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics', target: '_self', }, { label: 'JavaScript', - to: 'https://slack.dev/bolt-js', + to: 'https://tools.slack.dev/bolt-js', target: '_self', }, { label: 'Python', - to: 'https://slack.dev/bolt-python', + to: 'https://tools.slack.dev/bolt-python', target: '_self', }, ] @@ -211,17 +211,17 @@ const config = { items: [ { label: 'Java Slack SDK', - to: 'https://slack.dev/java-slack-sdk/', + to: 'https://tools.slack.dev/java-slack-sdk/', target: '_self', }, { label: 'Node Slack SDK', - to: 'https://slack.dev/node-slack-sdk/', + to: 'https://tools.slack.dev/node-slack-sdk/', target: '_self', }, { label: 'Python Slack SDK', - to: 'https://slack.dev/python-slack-sdk/', + to: 'https://tools.slack.dev/python-slack-sdk/', target: '_self', }, { @@ -238,7 +238,7 @@ const config = { items: [ { label: 'Community tools', - to: 'https://slack.dev/community-tools', + to: 'https://tools.slack.dev/community-tools', target: '_self', }, {