From 34bf2cb31b44ed1363e7378ac11b6a98cbc63faa Mon Sep 17 00:00:00 2001 From: Ella Katz Date: Tue, 13 Feb 2024 16:49:42 +0200 Subject: [PATCH] fix broken links and more stuff --- .../guides/alerts-code-configuration.mdx | 34 +++++++++---------- docs/_snippets/products-cards.mdx | 2 +- docs/features/elementary-alerts.mdx | 4 +-- docs/oss/cli-commands.mdx | 4 +-- .../deployment-and-configuration/slack.mdx | 2 +- .../deployment-and-configuration/teams.mdx | 2 +- docs/oss/guides/alerts/elementary-alerts.mdx | 2 +- docs/oss/guides/alerts/send-slack-alerts.mdx | 2 +- docs/oss/quickstart/quickstart-cli.mdx | 2 +- docs/release-notes/releases/0.5.4.mdx | 2 +- docs/release-notes/releases/0.6.3.mdx | 4 +-- docs/release-notes/releases/0.6.5.mdx | 4 +-- docs/release-notes/releases/0.6.7.mdx | 4 +-- docs/release-notes/releases/0.7.2.mdx | 2 +- docs/release-notes/releases/0.7.5.mdx | 2 +- docs/release-notes/releases/0.9.1.mdx | 2 +- .../elementary-overview.mdx | 2 +- 17 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/_snippets/guides/alerts-code-configuration.mdx b/docs/_snippets/guides/alerts-code-configuration.mdx index c38b3f5b5..d789f70d0 100644 --- a/docs/_snippets/guides/alerts-code-configuration.mdx +++ b/docs/_snippets/guides/alerts-code-configuration.mdx @@ -1,14 +1,14 @@ You can enrich your alerts by adding properties to tests, models and sources in your `.yml` files. -The supported attributes are: [owner](./alerts-configuration/#owner), -[subscribers](./alerts-configuration#subscribers), -[description](./alerts-configuration#test-description), -[tags](./alerts-configuration#tags). +The supported attributes are: [owner](./alerts-code-configuration/#owner), +[subscribers](./alerts-code-configuration#subscribers), +[description](./alerts-code-configuration#test-description), +[tags](./alerts-code-configuration#tags). You can configure and customize your alerts by configuring: -[custom channel](./alerts-configuration#custom-channel), -[suppression interval](./alerts-configuration#suppression_interval), -[alert fields](./alerts-configuration#alert_fields)(for test alerts only), [alert grouping](./alerts-configuration#group-alerts-by-table), -[alert filters](./alerts-configuration#filter-alerts). +[custom channel](./alerts-code-configuration#custom-channel), +[suppression interval](./alerts-code-configuration#suppression_interval), +[alert fields](./alerts-code-configuration#alert_fields)(for test alerts only), [alert grouping](./alerts-code-configuration#group-alerts-by-table), +[alert filters](./alerts-code-configuration#filter-alerts). ## Alert properties in `.yml` files @@ -30,14 +30,14 @@ Elementary prioritizes configuration in the following order: 
   
   meta:
-    owner: "@jessica.jones"
-    subscribers: ["@jessica.jones", "@joe.joseph"]
-    description: "This is the test description"
-    tags: ["#marketing", "#data_ops"]
-    channel: data_ops
-    alert_suppression_interval: 24
-    slack_group_alerts_by: table
-    alert_fields: ["description", "owners", "tags", "subscribers", ...]
+    owner: "@jessica.jones"
+    subscribers: ["@jessica.jones", "@joe.joseph"]
+    description: "This is the test description"
+    tags: ["#marketing", "#data_ops"]
+    channel: data_ops
+    alert_suppression_interval: 24
+    slack_group_alerts_by: table
+    alert_fields: ["description", "owners", "tags", "subscribers", ...]
@@ -434,7 +434,7 @@ You can choose to enable / disable alert types by adding a var to your `dbt_proj Vars will be deprecated soon! For OSS users, we recommend filtering the alerts - using [CLI selectors](/oss/guides/alerts-configuration#alerts-cli-flags) + using [CLI selectors](/oss/guides/alerts/alerts-configuration#alerts-cli-flags) instead. diff --git a/docs/_snippets/products-cards.mdx b/docs/_snippets/products-cards.mdx index d308f8bb0..afd9cefcb 100644 --- a/docs/_snippets/products-cards.mdx +++ b/docs/_snippets/products-cards.mdx @@ -5,7 +5,7 @@ Read about the key features and product offerings: title="Key Features" icon="stars" iconType="solid" - href="../../key-features" + href="/key-features" > Signup to cloud, and activate the Slack integration. - + Install the CLI tool, and configure a profile. Use the `edr monitor` command to send alerts. If you want continuous alerting, you will need to orchestrate the CLI. @@ -27,7 +27,7 @@ icon: "bell-exclamation" Use Alert Rules to distribute your alerts to the right channels. - + All alerts configuration is as code in your project YML files. diff --git a/docs/oss/cli-commands.mdx b/docs/oss/cli-commands.mdx index 37da6c087..748315251 100644 --- a/docs/oss/cli-commands.mdx +++ b/docs/oss/cli-commands.mdx @@ -88,7 +88,7 @@ Here is a list of all the available options: - **Select:** Filter the alerts / report using a selector. - - See all of the alerts supported selector methods [here](/oss/guides/alerts-configuration#alerts-cli-flags). + - See all of the alerts supported selector methods [here](/oss/guides/alerts/alerts-configuration#alerts-cli-flags). - See all of the report supported selector methods [here](/oss/guides/generate-report-ui#generating-a-report-for-single-invocation). ```shell @@ -195,7 +195,7 @@ Here is a list of all the available options: - **Suppression interval:** Suppress similar alerts for a given number of hours. - [Read more about this setting here.](/oss/guides/alerts-configuration#suppression-interval-flag) + [Read more about this setting here.](/oss/guides/alerts/alerts-configuration#suppression-interval-flag) The default suppression interval is 0. ```shell diff --git a/docs/oss/deployment-and-configuration/slack.mdx b/docs/oss/deployment-and-configuration/slack.mdx index 4d060149b..18079bc65 100644 --- a/docs/oss/deployment-and-configuration/slack.mdx +++ b/docs/oss/deployment-and-configuration/slack.mdx @@ -3,7 +3,7 @@ title: "Slack setup for Elementary CLI" sidebarTitle: "Slack" --- -Elementary Slack integration includes sending [Slack alerts](/oss/guides/send-slack-alerts) on failures in dbt tests and models, and the option to distribute the [data observability report](/oss/guides/generate-report-ui) as a message attachment. +Elementary Slack integration includes sending [Slack alerts](/oss/guides/alerts/send-slack-alerts) on failures in dbt tests and models, and the option to distribute the [data observability report](/oss/guides/generate-report-ui) as a message attachment. ## Token vs Webhook diff --git a/docs/oss/deployment-and-configuration/teams.mdx b/docs/oss/deployment-and-configuration/teams.mdx index 75ddf57fd..abadb1b84 100644 --- a/docs/oss/deployment-and-configuration/teams.mdx +++ b/docs/oss/deployment-and-configuration/teams.mdx @@ -3,7 +3,7 @@ title: "Teams setup for Elementary CLI" sidebarTitle: "Teams" --- -Elementary Teams integration includes sending [Teams alerts](/oss/guides/send-teams-alerts) on failures in dbt tests and models. +Elementary Teams integration includes sending [Teams alerts](/oss/guides/alerts/send-teams-alerts) on failures in dbt tests and models. ## Integration options diff --git a/docs/oss/guides/alerts/elementary-alerts.mdx b/docs/oss/guides/alerts/elementary-alerts.mdx index e6f25db13..1f4c3f5d5 100644 --- a/docs/oss/guides/alerts/elementary-alerts.mdx +++ b/docs/oss/guides/alerts/elementary-alerts.mdx @@ -24,7 +24,7 @@ title: "Elementary alerts"
` and ensure its validity. - `json_schema` - Validate the schema of JSON columns. 😱 - To ease configuration and implementation - both tests include operations to **auto-generate the schema.** diff --git a/docs/release-notes/releases/0.6.5.mdx b/docs/release-notes/releases/0.6.5.mdx index 8838975d2..8f6d19bdd 100644 --- a/docs/release-notes/releases/0.6.5.mdx +++ b/docs/release-notes/releases/0.6.5.mdx @@ -10,12 +10,12 @@ _January 10, 2023: [v0.6.5 Python](https://github.com/elementary-data/elementary - **Alerts suppression** 💤🔕 - Don't want to get multiple alerts if the same test keeps failing? - You can now configure an alert_suppression_interval, this is a "snooze" period for alerts on the same issue. - - [Docs here](/oss/guides/send-slack-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-layout-and-suppression) + - [Docs here](/oss/guides/alerts/elementary-alerts#customize-alerts-owners-test-descriptions-tags-subscribers-layout-and-suppression) - **Alerts filtering using selectors** 🔘 - You can now configure edr to send only selected alerts, using tags, owners or models selectors. - This enables you to send only the alerts you actually care about. - - [Docs here](/oss/guides/send-slack-alerts#execute-the-cli) + - [Docs here](/oss/guides/alerts/elementary-alerts#execute-the-cli) - **Generate report for a single invocation** 1️⃣ - Use selectors to generate a pre-filtered report with the results you want to see. diff --git a/docs/release-notes/releases/0.6.7.mdx b/docs/release-notes/releases/0.6.7.mdx index 0ef359e3e..2a632798d 100644 --- a/docs/release-notes/releases/0.6.7.mdx +++ b/docs/release-notes/releases/0.6.7.mdx @@ -9,12 +9,12 @@ _January 19, 2023: [v0.6.7 Python](https://github.com/elementary-data/elementary - **Postgres integration** 🆕 - Elementary now supports Postgres! Thank you [Tasos Kouridis](https://github.com/kouridis) for this meaningful contribution! - - [Docs here](/integrations/postgres) + - [Docs here](oss/integrations/postgres) - **Freshness anomalies monitoring improvements** 🥬 - We have split our freshness anomalies test into two different tests to better handle two common different use cases: - `freshness_anomalies` - monitors anomalies in the frequency of updates. Imagine a table that is being updated hourly and then all of a sudden this table wasn't updated for 4 hours. Here you would probably use the `updated_at`/`inserted_at` column as an input for this test. - `event_freshness_anomalies` - monitors that the underlying data is up to date. Imagine an events table that is being updated hourly correctly but the events themselves are coming with a delay of 2 days from your production databases. Here, you would probably use the `event_timestamp` column as an input for this test. - - [Docs here](guides/add-elementary-tests#table-model-source-tests) + - [Docs here](data-tests/anomaly-detection-tests/freshness-anomalies) ### 💫 More changes diff --git a/docs/release-notes/releases/0.7.2.mdx b/docs/release-notes/releases/0.7.2.mdx index cef5fb645..6d0a8ffed 100644 --- a/docs/release-notes/releases/0.7.2.mdx +++ b/docs/release-notes/releases/0.7.2.mdx @@ -11,7 +11,7 @@ _February 16, 2023: [v0.7.2 Python](https://github.com/elementary-data/elementar - When you generate a new report and using `send-report`, you can also trigger a Slack notification summary of the report. - This is useful for you and your team members to understand quickly if there is something in the new report you should address. - - [Docs here](/quickstart/share-report-ui#slack-summary-configurations), screen shot attached 📸 + - [Docs here](/oss/guides/share-report-ui#slack-summary-configurations), screen shot attached 📸 - **Dashboard graphs are now clickable** #️⃣📊 diff --git a/docs/release-notes/releases/0.7.5.mdx b/docs/release-notes/releases/0.7.5.mdx index c7138b2f1..ee4412c2e 100644 --- a/docs/release-notes/releases/0.7.5.mdx +++ b/docs/release-notes/releases/0.7.5.mdx @@ -11,7 +11,7 @@ _March 6, 2023: [v0.7.5 Python](https://github.com/elementary-data/elementary/re - Feeling overwhelmed by alerts on each failed test? - You can now add `-group-by table` to `edr monitor` and the table test results will be sent as one message. - - Docs are [here](/oss/guides/send-slack-alerts#notification-settings-decide-how-you-want-to-get-your-alerts) ; Pic attached 📸 + - Docs are [here](/oss/guides/alerts/elementary-alerts#notification-settings-decide-how-you-want-to-get-your-alerts) ; Pic attached 📸 - This was requested by [@Jake Beresford](https://elementary-community.slack.com/team/U03BN2E93SQ) and [@Ekaterina Khrushch](https://elementary-community.slack.com/team/U03PVN83DC2) - **Add `sum` to column anomaly tests** ➕ diff --git a/docs/release-notes/releases/0.9.1.mdx b/docs/release-notes/releases/0.9.1.mdx index a1b55f96f..20e0271b7 100644 --- a/docs/release-notes/releases/0.9.1.mdx +++ b/docs/release-notes/releases/0.9.1.mdx @@ -22,7 +22,7 @@ _July 20, 2023: [v0.9.1 Python](https://github.com/elementary-data/elementary/re - **Alert Suppression in CLI** 🚦 - Now, you can suppress alerts in the Command Line Interface (CLI) using the --suppression-interval flag. - This feature gives you more control over your alerts and helps you manage notifications effectively. - - Check out the [docs](https://docs.elementary-data.com/oss/guides/send-slack-alerts) + - Check out the [docs](https://docs.elementary-data.com) ### 💫 More changes diff --git a/docs/x_old/understand-elementary/elementary-overview.mdx b/docs/x_old/understand-elementary/elementary-overview.mdx index ebdd24123..9ab8608e5 100644 --- a/docs/x_old/understand-elementary/elementary-overview.mdx +++ b/docs/x_old/understand-elementary/elementary-overview.mdx @@ -24,7 +24,7 @@ Monitor the operations of your dbt easily. Collect dbt artifacts, run and test r The dbt artifacts uploader is included in the [dbt package](/guides/modules-overview/dbt-package). -## [Slack alerts](/oss/guides/send-slack-alerts) +## [Failure alerts](/oss/guides/alerts/elementary-alerts) Get notifications on data issues, schema changes, jobs and tests failures. Alerts are enriched with data from your dbt projects, such as owners, tags, results sample and test query.