Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,11 @@ repos:
language: system
files: ^elementary/.*\.py$

- repo: https://github.com/CoderJoshDK/precommit-mintlify-validate/
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a validation that we have no broken links in mintlify.
It didn't really run lately as docs aren't often updated by devs anymore - but it is useful so I made it work.

rev: v0.2.0
- repo: local
hooks:
- id: mintlify-validate
args: [docs]
name: Mintlify validate
entry: bash -c "cd docs && mintlify broken-links | tee /dev/stderr | grep -q 'no broken links found'"
language: system
require_serial: true
pass_filenames: false
9 changes: 5 additions & 4 deletions docs/_snippets/alerts/description.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ It's recommended to add an explanation of what does it mean if this test fails,
<CodeGroup>

```yml test
tests:
data_tests:
- not_null:
meta:
description: "This is the test description"
config:
meta:
description: "This is the test description"
```

```yml test config block
Expand All @@ -20,7 +21,7 @@ tests:
```

```yml dbt_project.yml
tests:
data_tests:
path:
subfolder:
+meta:
Expand Down
14 changes: 8 additions & 6 deletions docs/_snippets/alerts/owner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ Elementary enriches alerts with [owners for models or tests](https://docs.getdbt
```yml model
models:
- name: my_model_name
meta:
owner: "@jessica.jones"
config:
meta:
owner: "@jessica.jones"
```

```yml test
tests:
data_tests:
- not_null:
meta:
owner: ["@jessica.jones", "@joe.joseph"]
config:
meta:
owner: ["@jessica.jones", "@joe.joseph"]
```

```yml test/model config block
Expand All @@ -36,7 +38,7 @@ models/sources:
+meta:
owner: "@jessica.jones"

tests:
data_tests:
path:
subfolder:
+meta:
Expand Down
14 changes: 8 additions & 6 deletions docs/_snippets/alerts/subscribers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ If you want additional users besides the owner to be tagged on an alert, add the
```yml model
models:
- name: my_model_name
meta:
subscribers: "@jessica.jones"
config:
meta:
subscribers: "@jessica.jones"
```

```yml test
tests:
data_tests:
- not_null:
meta:
subscribers: ["@jessica.jones", "@joe.joseph"]
config:
meta:
subscribers: ["@jessica.jones", "@joe.joseph"]
```

```yml test/model config block
Expand All @@ -34,7 +36,7 @@ models:
+meta:
subscribers: "@jessica.jones"

tests:
data_tests:
path:
subfolder:
+meta:
Expand Down
4 changes: 2 additions & 2 deletions docs/_snippets/alerts/tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ models:
```

```yml test
tests:
data_tests:
- not_null:
tags: ["#marketing", "#data_ops"]
```
Expand All @@ -30,7 +30,7 @@ models:
subfolder:
tags: ["#marketing", "#data_ops"]

tests:
data_tests:
path:
subfolder:
tags: ["#marketing", "#data_ops"]
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/cloud/ai-privacy-policy-short.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Each agent may use the following data to provide recommendations:

Elementary does **not collect or share any sensitive data**, and you can review and align our AI use with your organization’s governance policies at any time.

For full details, see our [AI Privacy Policy](/cloud/ai-privacy).
For full details, see our [AI Privacy Policy](/cloud/general/ai-privacy-policy).
56 changes: 32 additions & 24 deletions docs/_snippets/guides/alerts-code-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,17 @@ the CLI or the `config.yml` file.
```yml model
models:
- name: my_model_name
meta:
channel: data_ops
config:
meta:
channel: data_ops
```

```yml test
tests:
data_tests:
- not_null:
meta:
channel: data_ops
config:
meta:
channel: data_ops
```

```yml test/model config block
Expand All @@ -102,7 +104,7 @@ models:
+meta:
channel: data_ops

tests:
data_tests:
path:
subfolder:
+meta:
Expand All @@ -126,15 +128,17 @@ Note: if you configure a suppression interval using this method, it will overrid
```yml model
models:
- name: my_model_name
meta:
alert_suppression_interval: 24
config:
meta:
alert_suppression_interval: 24
```

```yml test
tests:
data_tests:
- not_null:
meta:
alert_suppression_interval: 12
config:
meta:
alert_suppression_interval: 12
```

```yml test/model config block
Expand All @@ -152,7 +156,7 @@ models:
+meta:
alert_suppression_interval: 24

tests:
data_tests:
path:
subfolder:
+meta:
Expand All @@ -176,15 +180,17 @@ Due to their nature, grouped alerts will contain less information on each issue.
```yml model
models:
- name: my_model_name
meta:
slack_group_alerts_by: table
config:
meta:
slack_group_alerts_by: table
```

```yml test
tests:
data_tests:
- not_null:
meta:
slack_group_alerts_by: table
config:
meta:
slack_group_alerts_by: table
```

```yml test/model config block
Expand All @@ -202,7 +208,7 @@ models:
+meta:
slack_group_alerts_by: table

tests:
data_tests:
path:
subfolder:
+meta:
Expand Down Expand Up @@ -236,15 +242,17 @@ Supported alert fields:
```yml model
models:
- name: my_model_name
meta:
alert_fields: ["description", "owners", "tags", "subscribers"]
config:
meta:
alert_fields: ["description", "owners", "tags", "subscribers"]
```

```yml test
tests:
data_tests:
- not_null:
meta:
alert_fields: ["description", "owners", "tags", "subscribers"]
config:
meta:
alert_fields: ["description", "owners", "tags", "subscribers"]
```

```yml test/model config block
Expand All @@ -262,7 +270,7 @@ models:
+meta:
alert_fields: ["description", "owners", "tags", "subscribers"]

tests:
data_tests:
path:
subfolder:
+meta:
Expand Down
30 changes: 16 additions & 14 deletions docs/cloud/best-practices/governance-for-observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,15 @@ A data asset or test should have only one owner, but other people might want to
```yaml
models:
- name: return_on_ad_spend
tags:
- marketing-public
- marketing
meta:
owner: :"@analytics.engineer"
subscribers:
- "@marketing.data.analyst"
- "@another.marketing.data.analyst"
config:
tags:
- marketing-public
- marketing
meta:
owner: :"@analytics.engineer"
subscribers:
- "@marketing.data.analyst"
- "@another.marketing.data.analyst"
```

## Business domains & Data products
Expand Down Expand Up @@ -108,12 +109,13 @@ Ownership and subscribers:
```yaml
sources:
- name: fivetran_salesforce_sync
tags:
- fivetran
- salesforce
meta:
owner: :"@data.engineer"
subscribers: "@analytics.engineer"
config:
tags:
- fivetran
- salesforce
meta:
owner: :"@data.engineer"
subscribers: "@analytics.engineer"
```

<Check>
Expand Down
12 changes: 6 additions & 6 deletions docs/cloud/best-practices/triage-and-response.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ According to these answers, you should add configuration that will impact the al
</Check>

```yaml
tests:
data_tests:
- unique:
config:
error_if: ">10"
meta:
description: "More than 10 duplicate records arriving from the source, as this is a staging table"
owner: "@data.provider"
tags: "critical", "mongo-db", "raw-production-replica"
meta:
description: "More than 10 duplicate records arriving from the source, as this is a staging table"
owner: "@data.provider"
tags: "critical", "mongo-db", "raw-production-replica"
```

## Alert distribution
Expand Down Expand Up @@ -129,7 +129,7 @@ These are the questions that should be asked, and product tips on how to answer
- Does the incident break the pipeline / create delay?

- Is the failure is a model failure, or a freshness issue?
- Do we run `dbt build` and this failure stoped the pipeline?
- Do we run `dbt build` and this failure stopped the pipeline?

- Check the **Model runs** section of the dashboard to see if there are skipped models, as failures in build cause the downstream models to be skipped.

Expand Down
Loading
Loading