-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add feature guides for subscriptions and notifications
- Loading branch information
1 parent
cf617d7
commit 0fdcfeb
Showing
2 changed files
with
136 additions
and
111 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| import FeatureAvailability from '@site/src/components/FeatureAvailability'; | ||
|
|
||
| # Subscriptions & Notifications | ||
|
|
||
| <FeatureAvailability saasOnly /> | ||
|
|
||
| DataHub's Subscriptions and Notifications feature gives you real-time change alerts on data assets of your choice. | ||
| With this feature, you can set up subscriptions to specific changes for an Entity – and DataHub will notify you when those changes happen. Currently, DataHub supports notifications on Slack, with support for Microsoft Teams and email subscriptions forthcoming. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-user-notifications-in-slack.png"/> | ||
| </p> | ||
|
|
||
| This feature is especially useful in helping you stay on top of any upstream changes that could impact the assets you or your stakeholders rely on. It eliminates the need for you and your team to manually check for upstream changes, or for upstream stakeholders to identify and notify impacted users. | ||
| As a user, you can subscribe to and receive notifications about changes such as deprecations, schema changes, changes in ownership, assertions, or incidents. You’ll always been in the know about potential data quality issues so you can proactively manage your data resources. | ||
|
|
||
| https://www.loom.com/share/f02fe71e09494b5e82904c8a47f06ac1?sid=9379dd7f-b021-446a-8b5a-5838adeffd6b | ||
|
|
||
| <div style="position: relative; padding-bottom: 56.25%; height: 0;"> | ||
| <iframe src="https://www.loom.com/embed/f02fe71e09494b5e82904c8a47f06ac1?sid=ef041cb7-9c06-4926-8e0c-e948b1dc3af0" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| ## Setup, Prerequisites, and Permissions | ||
|
|
||
| Once you have configured Slack within your DataHub instance, you will be able to subscribe to any Entitiy in DataHub and begin recieving notifications via DM. | ||
|
|
||
| If you want to create and manage group-level Subscriptions for your team, you will need [the following privileges](../../docs/authorization/roles.md#role-privileges): | ||
|
|
||
| - Manage Group Notification Settings | ||
| - Manage Group Subscriptions | ||
|
|
||
| ## Using DataHub’s Subscriptions and Notifications Feature | ||
|
|
||
| The first step is identifying the assets you want to subscribe to. DataHub’s [Lineage and Impact Analysis features](../../docs/act-on-metadata/impact-analysis.md#lineage-impact-analysis-setup-prerequisites-and-permissions) can help you identify upstream entities that could impact the assets you use and are responsible for. | ||
|
|
||
| You can use the Subscriptions and Notifications feature to sign up for updates for your entire team, or just for yourself. | ||
|
|
||
| ### Subscribing Your Team/Group to Notifications | ||
|
|
||
| The dropdown menu next to the Subscribe button lets you choose who the subscription is for. To create a group subscription, click on Manage Group Subscriptions. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-subscription-dropdown.png"/> | ||
| </p> | ||
|
|
||
| Next, customize the group’s subscriptions by selecting the types of changes you want the group to be notified about. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-group-subscription-settings.png"/> | ||
| </p> | ||
|
|
||
| Connect to Slack. Currently, Acryl's Subscriptions and Notifications feature integrates only with Slack. Add your group’s Slack Channel ID to receive notifications on Slack. | ||
| (You can find your Channel ID in the About section of your channel on Slack.) | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-group-set-channel-id.png"/> | ||
| </p> | ||
|
|
||
| ### Individually Subscribing to an Entity | ||
|
|
||
| Select the **Subscribe Me** option in the Subscriptions dropdown menu. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-subscription-dropdown-zoom.png"/> | ||
| </p> | ||
|
|
||
| Pick the updates you want to be notified about, and connect your Slack account by using your Slack Member ID. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-user-subscription-setting.png"/> | ||
| </p> | ||
|
|
||
| :::note | ||
| You can find your Slack Member ID in your profile settings. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-user-set-user-id.png"/> | ||
| </p> | ||
| ::: | ||
|
|
||
| ### Managing Your Subscriptions | ||
|
|
||
| You can enable, disable, or manage notifications at any time to ensure that you receive relevant updates. | ||
|
|
||
| Simply use the Dropdown menu next to the Subscribe button to unsubscribe from the asset, or to manage/modify your subscription (say, to modify the changes you want to be updated about). | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-subscription-dropdown.png"/> | ||
| </p> | ||
|
|
||
| You can also view and manage your subscriptions in your DataHub settings page. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-user-subscriptions.png"/> | ||
| </p> | ||
|
|
||
| You can view and manage the group’s subscriptions on the group’s page on DataHub. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-group-subscriptions.png"/> | ||
| </p> | ||
|
|
||
| ## FAQ and Troubleshooting | ||
|
|
||
| <details> | ||
| <summary> | ||
| 1.What changes can I be notified about using this feature? | ||
| </summary> | ||
| You can subscribe to deprecations, Assertion status changes, Incident status changes, Schema changes, Ownership changes, Glossary Term changes, and Tag changes. | ||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-user-subscription-settings-zoom.jpg"/> | ||
| </p> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| 2. What if I no longer want to receive updates about a data asset? | ||
| </summary> | ||
| You can unsubscribe from any asset to stop receiving notifications about it. On the asset’s DataHub page, simply use the dropdown menu next to the Subscribe button to unsubscribe from the asset. | ||
|
|
||
| <p align="center"> | ||
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/df64ece310fa9bafbfc57bf0500c4930e5231051/imgs/saas/subscription-and-notification/s_n-subscription-dropdown.png"/> | ||
| </p> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| 3. What if I want to be notified about different changes? | ||
| </summary> | ||
| To modify your subscription, use the dropdown menu next to the Subscribe button to modify the changes you want to be notified about. | ||
| </details> | ||
|
|
||
| ## Reference | ||
|
|
||
| - [DataHub Blog - Simplifying Data Monitoring & Management with Subscriptions and Notifications with Acryl DataHub](https://www.acryldata.io/blog/simplifying-data-monitoring-and-management-with-subscriptions-and-notifications-with-acryl-datahub) |