Skip to content

Commit dc32203

Browse files
Build: remove docusaurus configuration files from repo (#2319)
1 parent 0ddbaf7 commit dc32203

File tree

1,154 files changed

+229
-18901
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,154 files changed

+229
-18901
lines changed

.github/maintainers_guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
7070

7171
- Push the new tag up to origin: `git push --tags origin`
7272

73-
8. Publish the release to npm
74-
- To publish, you need to be a member of the `slack Org` on npm and set up 2-Factor Auth with your passsword generator of choice. Before you can publish with npm, you must run `npm login` from the command line.
73+
7. Publish the release to npm
74+
- To publish, you need to be a member of the `slack Org` on npm and set up 2-Factor Auth with your password generator of choice. Before you can publish with npm, you must run `npm login` from the command line.
7575

7676
- As the final validation, within the package directory (ex: `packages/types`), run `mv package-lock.json package-lock.json.bk && rm -rf node_modules/ dist/ && npm i && npm test && npm pack` and confirm if there are `*.js`, `*.d.ts` files under the `dist` directory.
7777

@@ -163,7 +163,7 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
163163
### 🔖 Versioning and Tags
164164
This project is versioned using [Semantic Versioning](http://semver.org/), particularly in the [npm flavor](https://docs.npmjs.com/getting-started/semantic-versioning). Each release is tagged using git. The naming convention for tags is `{package_name}@{version}`. For example, the tag `@slack/[email protected]` marks the v5.0.0 release of the `@slack/web-api` package. A single commit will have multiple tags when multiple packages are released simultaneously.
165165

166-
One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack Platfrom CLI](https://tools.slack.dev/slack-cli/) itself.
166+
One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack CLI](https://docs.slack.dev/slack-cli/) itself.
167167

168168
### 🪵 Branches
169169
`main` is where active development occurs. Long running named feature branches are occasionally created for collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull Request). After a major version increment, a maintenance branch for the older major version is left open (e.g. `v3`, `v4`, etc).

.github/workflows/docs-deploy.yml

Lines changed: 0 additions & 65 deletions
This file was deleted.

README.md

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

77
## Getting Started
88

9-
Visit the [documentation site](https://tools.slack.dev/node-slack-sdk) for all the lovely details.
9+
Visit the [documentation site](https://docs.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
@@ -16,15 +16,15 @@ The Slack platform offers several APIs to build apps. Each Slack API delivers pa
1616
platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of
1717
Slack's APIs. They are small and powerful when used independently, and work seamlessly when used together, too.
1818

19-
**Just starting out?** The [Getting Started tutorial](https://slackapi.github.io/node-slack-sdk/getting-started) will
19+
**Just starting out?** The [Getting Started tutorial](https://docs.slack.dev/node-slack-sdk/getting-started) will
2020
walk you through building your first Slack app using Node.js.
2121

2222
| Slack API | Use | NPM Package |
2323
|--------------|--------------|-------------------|
24-
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://docs.slack.dev/reference/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) |
25-
| 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) |
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) |
24+
| Web API | Send data to or query data from Slack using any of [over 220 methods](https://docs.slack.dev/reference/methods). | [`@slack/web-api`](https://docs.slack.dev/node-slack-sdk/web-api) |
25+
| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://docs.slack.dev/node-slack-sdk/oauth) |
26+
| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://docs.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://docs.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://tools.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://docs.slack.dev/node-slack-sdk/migration/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://tools.slack.dev/node-slack-sdk/getting-started) that's perfect for just starting out, and each
53+
tutorial](https://docs.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://tools.slack.dev/bolt-js/concepts#event-listening).
91+
Refer to [Bolt for JavaScript document pages](https://docs.slack.dev/bolt-js/concepts#event-listening).
9292

9393
### Responding to interactive messages
9494

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

9797
### Using Socket Mode
9898

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).
99+
Refer to [the module document page](https://docs.slack.dev/node-slack-sdk/socket-mode) and [Bolt for JavaScript document page](https://docs.slack.dev/bolt-js/concepts#socket-mode).
100100

101101
## Requirements
102102

docs/.gitignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/README.md

Lines changed: 0 additions & 122 deletions
This file was deleted.

docs/babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/docusaurus.config.js

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)