Skip to content

Commit 4f25245

Browse files
Merge branch 'slackapi:main' into move-to-my-py
2 parents 1b4c401 + a5b9db6 commit 4f25245

Some content is hidden

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

56 files changed

+2924
-812
lines changed

.github/dependabot.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ updates:
1616
directory: "/docs"
1717
schedule:
1818
interval: "monthly"
19+
groups:
20+
docusaurus:
21+
patterns:
22+
- "@docusaurus/*"

.github/workflows/docs-deploy.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ on:
1212
paths:
1313
- "docs/**"
1414
workflow_dispatch:
15-
release:
1615

1716
jobs:
1817
build:

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/slack-sdk"></a>
1313
<a href="https://pypi.org/project/slack-sdk/">
1414
<img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/slack-sdk.svg"></a>
15-
<a href="https://slack.dev/python-slack-sdk/">
15+
<a href="https://tools.slack.dev/python-slack-sdk/">
1616
<img alt="Documentation" src="https://img.shields.io/badge/dev-docs-yellow"></a>
1717
</p>
1818

1919
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.
2020

21-
**Comprehensive documentation on using the Slack Python can be found at [https://slack.dev/python-slack-sdk/](https://slack.dev/python-slack-sdk/)**
21+
**Comprehensive documentation on using the Slack Python can be found at [https://tools.slack.dev/python-slack-sdk/](https://tools.slack.dev/python-slack-sdk/)**
2222

2323
---
2424

@@ -36,11 +36,11 @@ The **Python Slack SDK** allows interaction with:
3636
- `slack_sdk.models`: for constructing [Block Kit](https://api.slack.com/block-kit) UI components using easy-to-use builders
3737
- `slack_sdk.rtm`: for utilizing the [RTM API][rtm-docs]
3838

39-
If you want to use our [Events API][events-docs] and Interactivity features, please check the [Bolt for Python][bolt-python] library. Details on the Tokens and Authentication can be found in our [Auth Guide](https://slack.dev/python-slack-sdk/installation/).
39+
If you want to use our [Events API][events-docs] and Interactivity features, please check the [Bolt for Python][bolt-python] library. Details on the Tokens and Authentication can be found in our [Auth Guide](https://tools.slack.dev/python-slack-sdk/installation/).
4040

4141
## slackclient is in maintenance mode
4242

43-
Are you looking for [slackclient](https://pypi.org/project/slackclient/)? The website is live [here](https://slack.dev/python-slackclient/) just like before. However, the slackclient project is in maintenance mode now and this [`slack_sdk`](https://pypi.org/project/slack-sdk/) is the successor. If you have time to make a migration to slack_sdk v3, please follow [our migration guide](https://slack.dev/python-slack-sdk/v3-migration/) to ensure your app continues working after updating.
43+
Are you looking for [slackclient](https://pypi.org/project/slackclient/)? The website is live [here](https://tools.slack.dev/python-slackclient/) just like before. However, the slackclient project is in maintenance mode now and this [`slack_sdk`](https://pypi.org/project/slack-sdk/) is the successor. If you have time to make a migration to slack_sdk v3, please follow [our migration guide](https://tools.slack.dev/python-slack-sdk/v3-migration/) to ensure your app continues working after updating.
4444

4545
## Table of contents
4646

@@ -98,7 +98,7 @@ We've created this [tutorial](https://github.com/slackapi/python-slack-sdk/tree/
9898

9999
---
100100

101-
Slack provide a Web API that gives you the ability to build applications that interact with Slack in a variety of ways. This Development Kit is a module based wrapper that makes interaction with that API easier. We have a basic example here with some of the more common uses but a full list of the available methods are available [here][api-methods]. More detailed examples can be found in [our guide](https://slack.dev/python-slack-sdk/web/).
101+
Slack provide a Web API that gives you the ability to build applications that interact with Slack in a variety of ways. This Development Kit is a module based wrapper that makes interaction with that API easier. We have a basic example here with some of the more common uses but a full list of the available methods are available [here][api-methods]. More detailed examples can be found in [our guide](https://tools.slack.dev/python-slack-sdk/web/).
102102

103103
#### Sending a message to Slack
104104

@@ -267,7 +267,7 @@ print(response)
267267

268268
If you're migrating from slackclient v2.x of slack_sdk to v3.x, Please follow our migration guide to ensure your app continues working after updating.
269269

270-
**[Check out the Migration Guide here!](https://slack.dev/python-slack-sdk/v3-migration/)**
270+
**[Check out the Migration Guide here!](https://tools.slack.dev/python-slack-sdk/v3-migration/)**
271271

272272
### Migrating from v1
273273

docs/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# slack.dev/python-slack-sdk
1+
# tools.slack.dev/python-slack-sdk
22

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

@@ -20,7 +20,9 @@ docs/
2020
│ └── oslo.svg
2121
├── src/
2222
│ └── theme (only contains the 404 page)
23-
├── docusaurus.config.js (main config file. also where to set navbar/footer)
23+
├── docusaurus.config.js (main config file)
24+
├── footerConfig.js (footer. go to main repo to change)
25+
├── navbarConfig.js (navbar. go to main repo to change)
2426
└── sidebar.js (manually set where the content docs are in the sidebar.)
2527
```
2628

docs/content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Slack platform offers several APIs to build apps. Each Slack API delivers pa
1818
| Request Signature Verification | Verify incoming requests from the Slack API servers. | ``slack_sdk.signature`` |
1919
| UI Builders | Construct UI components using easy-to-use builders. | ``slack_sdk.models`` |
2020

21-
You can also view the [Python module documents](https://slack.dev/python-slack-sdk/api-docs/slack_sdk/)!
21+
You can also view the [Python module documents](https://tools.slack.dev/python-slack-sdk/api-docs/slack_sdk/)!
2222

2323
## Getting help
2424

docs/content/legacy/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This is the first stable version of [slack_sdk](https://pypi.org/project/slack-s
1010
warnings
1111

1212
Refer to [v3.0.0 milestone](https://github.com/slackapi/python-slack-sdk/milestone/10?closed=1)
13-
and [the website](https://slack.dev/python-slack-sdk/) for details. If you're a `slackclient` user, the migration guide for `slackclient` v2.x users is available at https://slack.dev/python-slack-sdk/v3-migration/
13+
and [the website](https://tools.slack.dev/python-slack-sdk/) for details. If you're a `slackclient` user, the migration guide for `slackclient` v2.x users is available at https://tools.slack.dev/python-slack-sdk/v3-migration/
1414

1515
## v2.9.3 (2020-10-20)
1616

docs/content/legacy/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The [slackclient](https://pypi.org/project/slackclient/) PyPI project is in main
66

77
:::
88

9-
Refer to [the migration guide](https://slack.dev/python-slack-sdk/v3-migration/index.html#from-slackclient-2-x) to learn how to smoothly migrate your existing code.
9+
Refer to [the migration guide](https://tools.slack.dev/python-slack-sdk/v3-migration/index.html#from-slackclient-2-x) to learn how to smoothly migrate your existing code.
1010

1111
Slack APIs allow anyone to build full featured integrations that extend and expand the capabilities of your Slack workspace. These APIs allow you to build applications that interact with Slack just like the people on your team — they can post messages, respond to events that happen — as well as build complex UIs for getting work done.
1212

docs/content/oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section explains the details about how to handle the Slack OAuth flow.
44

55
If you're looking for a much easier way to do the same, check [Bolt for Python](https://github.com/slackapi/bolt-python), which is a full-stack Slack App framework. With Bolt, you don't need to implement most of the following code on your own.
66

7-
View the [Python document for this module](https://slack.dev/python-slack-sdk/api-docs/slack_sdk/)
7+
View the [Python document for this module](https://tools.slack.dev/python-slack-sdk/api-docs/slack_sdk/)
88

99

1010
## App Installation Flow

docs/content/scim.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Refer to [the API document](https://api.slack.com/scim) for more details.
88

9-
View the [Python document for this module](https://slack.dev/python-slack-sdk/api-docs/slack_sdk/)
9+
View the [Python document for this module](https://tools.slack.dev/python-slack-sdk/api-docs/slack_sdk/)
1010

1111
## SCIMClient
1212

docs/content/v3-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ is not so simple that we recommend manually replacing imports for those.
5656
That said, all existing code can be migrated to v3 without any code
5757
changes. If you don't have time for it, you can use `slack` package
5858
with deprecation warnings saying
59-
`UserWarning: slack package is deprecated. Please use slack_sdk.web/webhook/rtm package instead. For more info, go to https://slack.dev/python-slack-sdk/v3-migration/`
59+
`UserWarning: slack package is deprecated. Please use slack_sdk.web/webhook/rtm package instead. For more info, go to https://tools.slack.dev/python-slack-sdk/v3-migration/`
6060
for a while. We won't remove the compatibility in the short term.
6161

6262
------------------------------------------------------------------------

0 commit comments

Comments
 (0)