Skip to content

Commit

Permalink
Update README + docs with deprecation notice (#1258)
Browse files Browse the repository at this point in the history
* [#1225] Update README with deprecation notice

* [#1225] Add deprecation notice to slack.dev
  • Loading branch information
misscoded committed Jun 5, 2021
1 parent 80ae05c commit 9ce135f
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -4,6 +4,16 @@
[![codecov](https://codecov.io/gh/slackapi/node-slack-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/slackapi/node-slack-sdk)
<!-- TODO: npm versions with scoped packages: https://github.com/rvagg/nodei.co/issues/24 -->

### **Deprecation Notice**

_`@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._

___

## Getting Started

Visit the [documentation site](https://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
Expand Down
8 changes: 8 additions & 0 deletions docs/_main/index.md
Expand Up @@ -10,6 +10,14 @@ headings:
- title: Getting Help
---

### **Deprecation Notice**

_`@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._

---

The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from the
platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of
Slack's APIs. They are small and powerful when used independently, and work seamlessly when used together, too.
Expand Down
6 changes: 6 additions & 0 deletions docs/_packages/events_api.md
Expand Up @@ -9,6 +9,12 @@ The `@slack/events-api` package helps your app respond to events from Slack's [E
such as new messages, emoji reactions, files, and much more. This package will help you start with convenient and secure
defaults.

### **Deprecation Notice**

_`@slack/events-api` officially reached EOL on May 31st, 2021. Development has fully stopped for this package 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._

## Installation

```shell
Expand Down
6 changes: 6 additions & 0 deletions docs/_packages/interactive_messages.md
Expand Up @@ -9,6 +9,12 @@ order: 3
The `@slack/interactive-messages` helps your app respond to interactions from Slack's
[interactive messages](https://api.slack.com/messaging/interactivity), [actions](https://api.slack.com/actions), and [dialogs](https://api.slack.com/dialogs). This package will help you start with convenient and secure defaults.

### **Deprecation Notice**

_`@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for this package 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._

## Installation

```shell
Expand Down
6 changes: 6 additions & 0 deletions packages/events-api/README.md
Expand Up @@ -4,6 +4,12 @@ The `@slack/events-api` package helps your app respond to events from Slack's [E
such as new messages, emoji reactions, files, and much more. This package will help you start with convenient and secure
defaults.

### **Deprecation Notice**

_`@slack/events-api` officially reached EOL on May 31st, 2021. Development has fully stopped for this package 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._

## Installation

```shell
Expand Down
7 changes: 6 additions & 1 deletion packages/interactive-messages/README.md
@@ -1,8 +1,13 @@
# Slack Interactive Messages for Node

The `@slack/interactive-messages` helps your app respond to interactions from Slack's
`@slack/interactive-messages` helps your app respond to interactions from Slack's
[interactive messages](https://api.slack.com/messaging/interactivity), [actions](https://api.slack.com/actions), and [dialogs](https://api.slack.com/dialogs). This package will help you start with convenient and secure defaults.

### **Deprecation Notice**

_`@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for this package 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._
## Installation

```shell
Expand Down

0 comments on commit 9ce135f

Please sign in to comment.