The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs: new place for alerts (#64688)
Alex Yaroshdb08e2353021
diff --git a/docs/exploration-and-organization/delete-and-restore.md b/docs/exploration-and-organization/delete-and-restore.mdindex 8fef987382d..e41bfce601d 100644--- a/docs/exploration-and-organization/delete-and-restore.md+++ b/docs/exploration-and-organization/delete-and-restore.md@@ -1,10 +1,11 @@---title: Delete and restore+summary: You can move questions, dashboards, models, and metrics to Trash where they can be restored or permanently deleted. Deleting items affects related content like dashboards and subscriptions. Other entities in Metabase can be deleted or archived, but won't show up in Trash.---# Delete and restore-Sometimes your questions, dashboards, models, or collections outlive their usefulness. You can send outdated items to **Trash**.+Sometimes your questions, dashboards, models, metrics, or collections outlive their usefulness. You can send outdated items to **Trash**.@@ -104,7 +105,7 @@ What happens to related items when you delete a collection?| ---------------------------------------------- | -------- | ------------------- | -------- || All items and subcollections in the collection | In Trash | N/A | Restored |-> You can't permanently delete collections+> You can't permanently delete collections.## Permanently deleting items@@ -117,7 +118,7 @@ To permanently delete an item:3. Click on the checkbox next to the item to select it;4. Select "Permanently delete". If you click this button, you won't be able to recover the item. It'll be lost to the void.-> You can't permanently delete collections+> You can't permanently delete collections.## Deleting and restoring events and timelines@@ -131,13 +132,11 @@ Snippets can be archived and unarchived. See [Archiving snippets](../questions/n## Deleting segments-Segments can be retired. See [Retiring Segments](../data-modeling/segments.md#editing-and-retiring-segments).--You won't see retired Segments in Trash.+Segments can be retired. See [Retiring Segments](../data-modeling/segments.md#editing-and-retiring-segments). You won't see retired Segments in Trash.## Deleting subscriptions and alerts-See [Deleting a subscription](../dashboards/subscriptions.md#deleting-a-subscription) and [Deleting alerts](../questions/alerts.md#editing-and-deleting-alerts).+See [Deleting a subscription](../dashboards/subscriptions.md#deleting-a-subscription) and [Deleting alerts](../questions/alerts.md#editing-deleting-and-unsubscribing-from-alerts).## Deleting databasesdiff --git a/docs/questions/alerts.md b/docs/questions/alerts.mdindex 4d89a6dbffb..b88cb8417d8 100644--- a/docs/questions/alerts.md+++ b/docs/questions/alerts.md@@ -29,13 +29,16 @@ Only admins and people with [settings access](../permissions/application.md#settTo create an alert:1. Save your question.-2. Click on the sharing icon in the top-right of the screen.+2. Click on the **three dots** in the top-right of the screen.3. Select **Create an alert**.-4. Select what you want to be alerted about. The alert options will depend on the question's visualization. See [types of alerts](#types-of-alerts).-5. Select when you want Metabase to check the results. Metabase can check for results by the minute, hourly, daily, weekly, monthly, or on a custom schedule that you set using the Quartz [cron syntax](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).-6. Select the alert's destination: [email](../configuring-metabase/email.md), [Slack](../configuring-metabase/slack.md), or to a [webhook](../configuring-metabase/webhooks.md) (only admins and people with [settings access](../permissions/application.md#settings-access) can create and send to webhooks).-7. Configure any other options (like [only sending the alert once](#send-a-one-time-alert)).-8. Click **Done**.+4. Select what you want to be alerted about (options depend on the question type):+ - [When a question returns a result](#results-alerts) - for any question.+ - [When a time series crosses a goal line](#goal-line-alerts) - for a line, bar, or area chart displaying a time series.+ - [When a progress bar reaches or goes below its goal](#progress-bar-alerts) - for progress bars.+6. Select when you want Metabase to check the results: by the minute, hourly, daily, weekly, monthly, or on a custom schedule that you set using the Quartz [cron syntax](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).+7. Select the alert's destination: [email](../configuring-metabase/email.md), [Slack](../configuring-metabase/slack.md), or to a [webhook](../configuring-metabase/webhooks.md) (only admins and people with [settings access](../permissions/application.md#settings-access) can create and send to webhooks).+8. Configure any other options (like [only sending the alert once](#send-a-one-time-alert)).+9. Click **Done**.## Send a one-time alert@@ -47,12 +50,6 @@ To test the alert, first make sure that the question returns results (if the queThen hit the **Send now** button to trigger the alert.-## Types of alerts--- [Results alerts](#results-alerts): when a question returns any result.-- [Goal line alerts](#goal-line-alerts) when a time series crosses a goal line.-- [Progress bar alerts](#progress-bar-alerts): when a progress bar reaches or goes below its goal.-## Results alertsMetabase can send you an alert on a schedule when one of your questions returns _any_ result. This kind of alert is also particularly useful if you have a question that doesn't _usually_ return any results, but you want to know when the question _does_ return results.@@ -69,27 +66,22 @@ _Requires a [bar, line, or area chart](./visualizations/line-bar-and-area-chartsGoal line alerts are useful when you're doing things like tracking daily active users (DAU) and you want to know when you reach a certain number of DAU, or when you're tracking orders per week and you want to know whenever the number of orders ever goes below a certain threshold.-To start, you'll need a line, area, or bar chart displaying a number over time.--Next, you need to set up a goal line on your chart. Open up the visualization settings by clicking the **gear** icon in the bottom-left. Then click on the **Display** tab, and turn on the **Show goal** setting. Choose a value for your goal (and optionally a label) and click Done.--You can choose:--- Whether you want Metabase to alert you when the time series goes above the goal line or when it goes below the goal line.-- Whether you want Metabase to alert you every time the time series crosses a goal line, or only the first time it crosses the goal line.-- How often you want Metabase to check to see if the goal line has been crossed.+To create an alert when a time series crosses a goal line:-Click Done, and your alert will be all set up!+1. Create a line, area, or bar chart displaying a number over time.+2. Open up the visualization settings by clicking the **gear** icon in the bottom-left.+3. In the **Display** tab, turn on the **Show goal** setting.+4. Choose a value for your goal (and optionally a label) and click Done.+5. Save the question.+6. Click the **three dots** icon in top and select "Create alert"-If you need to edit or unsubscribe from the alert you set up, just click that same icon. You'll see the Edit and Unsubscribe buttons. This is also where you'll see alerts about this question that admins might have added you to.+ You can choose:++ - Whether you want Metabase to alert you when the time series goes above the goal line or when it goes below the goal line.+ - Whether you want Metabase to alert you every time the time series crosses a goal line, or only the first time it crosses the goal line.+ - How often you want Metabase to check to see if the goal line has been crossed.-Metabase will email you when:--- You set up an alert-- You've been unsubscribed from an alert-- One of your alerts has stopped working-- You unsubscribed from an alert-- An admin added you to an alert+7. Select the schedule and recepients for the alert, and click "Done"## Progress bar alerts@@ -97,11 +89,11 @@ _Requires the [progress bar visualization](./visualizations/progress-bar.md)._If you want to set up an alert when a single number reaches a goal, you can use a progress bar visualization.-1. Create a question that returns a single number as its result,-2. Choose the Progress Bar chart type,-3. In Visualization settings, select a goal value-4. Save your question,-5. Create an alert by clicking on the Sharing icon in top right+1. Create a question that returns a single number as its result.+2. Choose the Progress Bar chart type.+3. In Visualization settings, select a goal value.+4. Save your question.+5. Create an alert by clicking the **three dots** in top right.You'll see the options for when you want to get alerts about this progress bar:@@ -109,9 +101,9 @@ You'll see the options for when you want to get alerts about this progress bar:- Whether to alert only the first time the progress bar reaches the goal line, or every time- How often you want Metabase to check to see if the goal has been reached.-## Editing and deleting alerts+## Editing, deleting, and unsubscribing from alerts-To edit or delete alerts on a question, click on the Sharing icon in the top right corner. What you can edit depends on whether you're an admin.+To edit or delete alerts on a question, click on the **three dots** icon in the top right corner and select **Edit alerts**. What you can edit depends on whether you're an admin.Everyone:@@ -124,6 +116,14 @@ Admins:- Admins can add or remove recipients on any alert, even ones that they didn't create themselves.- Admins can bulk manage alerts per person from the [People menu in Admin settings](../people-and-groups/managing.md#unsubscribe-from-all-subscriptions-and-alerts).+Metabase will email you when:++- You set up an alert+- You've been unsubscribed from an alert+- One of your alerts has stopped working+- You unsubscribed from an alert+- An admin added you to an alert+## Avoid changing the name of the alerted channel in SlackOnce you set up an alert to a Slack channel, avoid changing the name of that channel in Slack. If you rename the channel in Slack, but you want Metabase to continue to send alerts to that renamed channel, you'll need to update the alert in Metabase to point to the new channel name.