docs: add docs on DataHub slack bot (#13834)

This commit is contained in:
Harshal Sheth 2025-06-23 15:31:18 -07:00 committed by GitHub
parent a17dbf4849
commit 9bfcdb2a3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 44 additions and 11 deletions

View File

@ -364,12 +364,12 @@ module.exports = {
Slack: [
{
type: "doc",
id: "docs/managed-datahub/slack/saas-slack-setup",
id: "docs/managed-datahub/slack/saas-slack-app",
className: "saasOnly",
},
{
type: "doc",
id: "docs/managed-datahub/slack/saas-slack-app",
id: "docs/managed-datahub/slack/saas-slack-setup",
className: "saasOnly",
},
{

View File

@ -8,12 +8,25 @@ import FeatureAvailability from '@site/src/components/FeatureAvailability';
The DataHub Slack App brings several of DataHub's key capabilities directly into your Slack experience. These include:
1. Searching for Data Assets
2. Subscribing to notifications for Data Assets
3. Managing Data Incidents
1. Receive notifications
2. Searching for Data Assets
3. Subscribing to notifications for Data Assets
4. Managing Data Incidents
5. Chat with the @DataHub bot
_Our goal with the Slack app is to make data discovery easier and more accessible for you._
Learn more about [how to set up the Slack app](./saas-slack-setup.md) or [how to troubleshoot issues](./saas-slack-troubleshoot.md).
## Receive Notifications
The DataHub Slack app can send notifications to Slack channels and direct messages.
Notifications [can be configured](../subscription-and-notification.md) in the DataHub UI once the [Slack app is set up](./saas-slack-setup.md#configure-notifications).
<p align="center">
<img width="70%" alt="Example DataHub notification in Slack." src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/notification_1.png" />
</p>
## Slack App Commands
The command-based capabilities on the Slack App revolve around search.
@ -64,6 +77,24 @@ If you choose to `Mark as Resolved` the message will update in-place, and you wi
<img width="70%" alt="Example of search results being displayed within Slack." src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/slack_incidents_2.png" />
</p>
## Coming Soon
## @DataHub Slack Bot
We're constantly working on rolling out new features for the Slack app, stay tuned!
With the DataHub Slack bot, you can mention @DataHub in any channel and ask it questions about your metadata.
Key capabilities include:
- Find relevant data assets.
- Understand the impact of changes to data assets.
- Dig into specific assets and their glossary terms, owners, and more.
- Write first-drafts of SQL queries to answer specific questions.
- Get notified about incidents and updates.
:::info
As of DataHub Cloud v0.3.12, the DataHub Slack bot is in private beta. Reach out to your DataHub Cloud representative to get access.
:::
<p align="center">
<img width="60%" alt="Chat experience in Slack with the @DataHub bot." src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/saas/slack/chatbot_1.png" />
</p>

View File

@ -1,6 +1,6 @@
import FeatureAvailability from '@site/src/components/FeatureAvailability';
# Configure Slack For Notifications
# Slack App Setup
<FeatureAvailability saasOnly />
@ -176,7 +176,7 @@ To customize the channel where notifications are send, click the button to the r
If provided, a custom channel will be used to route notifications of the given type. If not provided, the default channel will be used.
That's it! You should begin to receive notifications on Slack. Note that it may take up to 1 minute for notification settings to take effect after saving. -->
## Sending Notifications
## Configure Notifications
For now, we support sending notifications to
@ -186,7 +186,9 @@ For now, we support sending notifications to
By default, the Slack app will be able to send notifications to public channels. If you want to send notifications to private channels or DMs, you will need to invite the Slack app to those channels.
## How to find Team ID and Channel ID in Slack
Learn more about how [subscriptions and notifications work](../subscription-and-notification.md), including what things you can be notified about and all the places you can receive notifications.
### How to find Team ID and Channel ID in Slack
:::note
We recommend just using the Slack channel name for simplicity (e.g. `#troubleshoot`).
@ -215,7 +217,7 @@ We recommend just using the Slack channel name for simplicity (e.g. `#troublesho
- Team ID = `TUMKD5EGJ` from above
- Channel ID = `C029A3M079U` from above
## How to find User ID in Slack
### How to find User ID in Slack
**Your User ID**