Skip to content

Commit f2c3467

Browse files
authored
change docs to match dbt fusion (#2019)
* change docs to match dbt fusion * fix broken links * change comment * add a mintlify hook that works * dbt-fusion: initial page * dbt-fusion page in docs side tree * troubleshooting fixes * dbt fusion guide - add more details about upgrading from dbt-core * dbt-fusion: docs fixes
1 parent 653b3a2 commit f2c3467

53 files changed

Lines changed: 918 additions & 661 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.pre-commit-config.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ repos:
4444
language: system
4545
files: ^elementary/.*\.py$
4646

47-
- repo: https://github.com/CoderJoshDK/precommit-mintlify-validate/
48-
rev: v0.2.0
47+
- repo: local
4948
hooks:
5049
- id: mintlify-validate
51-
args: [docs]
50+
name: Mintlify validate
51+
entry: bash -c "cd docs && mintlify broken-links | tee /dev/stderr | grep -q 'no broken links found'"
52+
language: system
53+
require_serial: true
54+
pass_filenames: false

docs/_snippets/alerts/description.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ It's recommended to add an explanation of what does it mean if this test fails,
44
<CodeGroup>
55

66
```yml test
7-
tests:
7+
data_tests:
88
- not_null:
9-
meta:
10-
description: "This is the test description"
9+
config:
10+
meta:
11+
description: "This is the test description"
1112
```
1213
1314
```yml test config block
@@ -20,7 +21,7 @@ tests:
2021
```
2122

2223
```yml dbt_project.yml
23-
tests:
24+
data_tests:
2425
path:
2526
subfolder:
2627
+meta:

docs/_snippets/alerts/owner.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ Elementary enriches alerts with [owners for models or tests](https://docs.getdbt
88
```yml model
99
models:
1010
- name: my_model_name
11-
meta:
12-
owner: "@jessica.jones"
11+
config:
12+
meta:
13+
owner: "@jessica.jones"
1314
```
1415
1516
```yml test
16-
tests:
17+
data_tests:
1718
- not_null:
18-
meta:
19-
owner: ["@jessica.jones", "@joe.joseph"]
19+
config:
20+
meta:
21+
owner: ["@jessica.jones", "@joe.joseph"]
2022
```
2123
2224
```yml test/model config block
@@ -36,7 +38,7 @@ models/sources:
3638
+meta:
3739
owner: "@jessica.jones"
3840

39-
tests:
41+
data_tests:
4042
path:
4143
subfolder:
4244
+meta:

docs/_snippets/alerts/subscribers.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ If you want additional users besides the owner to be tagged on an alert, add the
88
```yml model
99
models:
1010
- name: my_model_name
11-
meta:
12-
subscribers: "@jessica.jones"
11+
config:
12+
meta:
13+
subscribers: "@jessica.jones"
1314
```
1415
1516
```yml test
16-
tests:
17+
data_tests:
1718
- not_null:
18-
meta:
19-
subscribers: ["@jessica.jones", "@joe.joseph"]
19+
config:
20+
meta:
21+
subscribers: ["@jessica.jones", "@joe.joseph"]
2022
```
2123
2224
```yml test/model config block
@@ -34,7 +36,7 @@ models:
3436
+meta:
3537
subscribers: "@jessica.jones"
3638

37-
tests:
39+
data_tests:
3840
path:
3941
subfolder:
4042
+meta:

docs/_snippets/alerts/tags.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ models:
1212
```
1313
1414
```yml test
15-
tests:
15+
data_tests:
1616
- not_null:
1717
tags: ["#marketing", "#data_ops"]
1818
```
@@ -30,7 +30,7 @@ models:
3030
subfolder:
3131
tags: ["#marketing", "#data_ops"]
3232

33-
tests:
33+
data_tests:
3434
path:
3535
subfolder:
3636
tags: ["#marketing", "#data_ops"]

docs/_snippets/cloud/ai-privacy-policy-short.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ Each agent may use the following data to provide recommendations:
1717

1818
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.
1919

20-
For full details, see our [AI Privacy Policy](/cloud/ai-privacy).
20+
For full details, see our [AI Privacy Policy](/cloud/general/ai-privacy-policy).

docs/_snippets/guides/alerts-code-configuration.mdx

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,17 @@ the CLI or the `config.yml` file.
7676
```yml model
7777
models:
7878
- name: my_model_name
79-
meta:
80-
channel: data_ops
79+
config:
80+
meta:
81+
channel: data_ops
8182
```
8283
8384
```yml test
84-
tests:
85+
data_tests:
8586
- not_null:
86-
meta:
87-
channel: data_ops
87+
config:
88+
meta:
89+
channel: data_ops
8890
```
8991
9092
```yml test/model config block
@@ -102,7 +104,7 @@ models:
102104
+meta:
103105
channel: data_ops
104106

105-
tests:
107+
data_tests:
106108
path:
107109
subfolder:
108110
+meta:
@@ -126,15 +128,17 @@ Note: if you configure a suppression interval using this method, it will overrid
126128
```yml model
127129
models:
128130
- name: my_model_name
129-
meta:
130-
alert_suppression_interval: 24
131+
config:
132+
meta:
133+
alert_suppression_interval: 24
131134
```
132135

133136
```yml test
134-
tests:
137+
data_tests:
135138
- not_null:
136-
meta:
137-
alert_suppression_interval: 12
139+
config:
140+
meta:
141+
alert_suppression_interval: 12
138142
```
139143

140144
```yml test/model config block
@@ -152,7 +156,7 @@ models:
152156
+meta:
153157
alert_suppression_interval: 24
154158
155-
tests:
159+
data_tests:
156160
path:
157161
subfolder:
158162
+meta:
@@ -176,15 +180,17 @@ Due to their nature, grouped alerts will contain less information on each issue.
176180
```yml model
177181
models:
178182
- name: my_model_name
179-
meta:
180-
slack_group_alerts_by: table
183+
config:
184+
meta:
185+
slack_group_alerts_by: table
181186
```
182187

183188
```yml test
184-
tests:
189+
data_tests:
185190
- not_null:
186-
meta:
187-
slack_group_alerts_by: table
191+
config:
192+
meta:
193+
slack_group_alerts_by: table
188194
```
189195

190196
```yml test/model config block
@@ -202,7 +208,7 @@ models:
202208
+meta:
203209
slack_group_alerts_by: table
204210
205-
tests:
211+
data_tests:
206212
path:
207213
subfolder:
208214
+meta:
@@ -236,15 +242,17 @@ Supported alert fields:
236242
```yml model
237243
models:
238244
- name: my_model_name
239-
meta:
240-
alert_fields: ["description", "owners", "tags", "subscribers"]
245+
config:
246+
meta:
247+
alert_fields: ["description", "owners", "tags", "subscribers"]
241248
```
242249

243250
```yml test
244-
tests:
251+
data_tests:
245252
- not_null:
246-
meta:
247-
alert_fields: ["description", "owners", "tags", "subscribers"]
253+
config:
254+
meta:
255+
alert_fields: ["description", "owners", "tags", "subscribers"]
248256
```
249257

250258
```yml test/model config block
@@ -262,7 +270,7 @@ models:
262270
+meta:
263271
alert_fields: ["description", "owners", "tags", "subscribers"]
264272
265-
tests:
273+
data_tests:
266274
path:
267275
subfolder:
268276
+meta:

docs/cloud/best-practices/governance-for-observability.mdx

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,15 @@ A data asset or test should have only one owner, but other people might want to
4343
```yaml
4444
models:
4545
- name: return_on_ad_spend
46-
tags:
47-
- marketing-public
48-
- marketing
49-
meta:
50-
owner: :"@analytics.engineer"
51-
subscribers:
52-
- "@marketing.data.analyst"
53-
- "@another.marketing.data.analyst"
46+
config:
47+
tags:
48+
- marketing-public
49+
- marketing
50+
meta:
51+
owner: :"@analytics.engineer"
52+
subscribers:
53+
- "@marketing.data.analyst"
54+
- "@another.marketing.data.analyst"
5455
```
5556
5657
## Business domains & Data products
@@ -108,12 +109,13 @@ Ownership and subscribers:
108109
```yaml
109110
sources:
110111
- name: fivetran_salesforce_sync
111-
tags:
112-
- fivetran
113-
- salesforce
114-
meta:
115-
owner: :"@data.engineer"
116-
subscribers: "@analytics.engineer"
112+
config:
113+
tags:
114+
- fivetran
115+
- salesforce
116+
meta:
117+
owner: :"@data.engineer"
118+
subscribers: "@analytics.engineer"
117119
```
118120

119121
<Check>

docs/cloud/best-practices/triage-and-response.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ According to these answers, you should add configuration that will impact the al
3838
</Check>
3939

4040
```yaml
41-
tests:
41+
data_tests:
4242
- unique:
4343
config:
4444
error_if: ">10"
45-
meta:
46-
description: "More than 10 duplicate records arriving from the source, as this is a staging table"
47-
owner: "@data.provider"
48-
tags: "critical", "mongo-db", "raw-production-replica"
45+
meta:
46+
description: "More than 10 duplicate records arriving from the source, as this is a staging table"
47+
owner: "@data.provider"
48+
tags: "critical", "mongo-db", "raw-production-replica"
4949
```
5050
5151
## Alert distribution
@@ -129,7 +129,7 @@ These are the questions that should be asked, and product tips on how to answer
129129
- Does the incident break the pipeline / create delay?
130130

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

134134
- 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.
135135

0 commit comments

Comments
 (0)