Skip to content

Commit ffafd3e

Browse files
committed
correct asset paths
1 parent 5122c5a commit ffafd3e

25 files changed

+105
-105
lines changed

docs/demo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Try `Recce` without installing using this [online demo](https://pr1.cloud.datare
1212
The demo showcases a [pull request](https://github.com/DataRecce/jaffle_shop_duckdb/pull/1) that fixes the `customer_lifetime_value` calculation in dbt's Jaffle Shop project to only included completed orders.
1313

1414
<figure markdown>
15-
![customers.sql](../assets/images/demo/clv-customers-model-fs8.png){: .shadow}
15+
![customers.sql](assets/images/demo/clv-customers-model-fs8.png){: .shadow}
1616
<figcaption>Jaffle Shop customers.sql</figcaption>
1717
</figure>
1818

@@ -26,7 +26,7 @@ Some example validation checks you might create include:
2626
Run a [Value Diff](features/lineage.md#value-diff) to check the percentage match of the `customer_lifetime_value` column between production and the development branch.
2727

2828
<figure markdown>
29-
![CLV Value Diff](../assets/images/demo/clv-value-diff-fs8.png)
29+
![CLV Value Diff](assets/images/demo/clv-value-diff-fs8.png)
3030
<figcaption>Value Diff - Customers Model</figcaption>
3131
</figure>
3232

@@ -35,7 +35,7 @@ Run a [Value Diff](features/lineage.md#value-diff) to check the percentage match
3535
Check the [Profile Diff](features/lineage.md#profile-diff) of the customers table to see how the `customer_lifetime_value` has been impacted.
3636

3737
<figure markdown>
38-
![CLV Profile Diff](../assets/images/demo/clv-profile-diff-fs8.png)
38+
![CLV Profile Diff](assets/images/demo/clv-profile-diff-fs8.png)
3939
<figcaption>Profile Diff - Customers Model</figcaption>
4040
</figure>
4141

@@ -48,7 +48,7 @@ select customer_id, customer_lifetime_value from {{ ref("customers") }} where cu
4848
```
4949

5050
<figure markdown>
51-
![CLV Query Diff](../assets/images/demo/clv-query-diff-fs8.png)
51+
![CLV Query Diff](assets/images/demo/clv-query-diff-fs8.png)
5252
<figcaption>Query Diff - Customers Model</figcaption>
5353
</figure>
5454

docs/features/breaking-change-analysis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ All modified models display their change category directly on the node. Addition
2727

2828
=== "Disabled"
2929

30-
![Breaking Change Analysis (disabled)](../../assets/images/features/breaking-change-disabled.png){: .shadow}
30+
![Breaking Change Analysis (disabled)](../assets/images/features/breaking-change-disabled.png){: .shadow}
3131

3232
=== "Enabled"
3333

34-
![Breaking Change Analysis](../../assets/images/features/breaking-change.png){: .shadow}
34+
![Breaking Change Analysis](../assets/images/features/breaking-change.png){: .shadow}
3535

3636

3737
## Column-Level Lineage
3838

3939
In models classified as **non-breaking** or **partial breaking** - added, removed, or modified columns will be listed. Click on a column to open its [Column-Level Lineage](./column-level-lineage.md)
4040

41-
![Column-level lineage](../../assets/images/features/breaking-change-lineage.png){: .shadow}
41+
![Column-level lineage](../assets/images/features/breaking-change-lineage.png){: .shadow}
4242

4343
## Limitations
4444

docs/features/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Save your validation checks to the Recce checklist with a description of your fi
1010
These checks can later be added to your pull request comment as proof-of-correctness for your modeling changes.
1111

1212
<figure markdown>
13-
![Recce Checklist](../../assets/images/features/checklist.png)
13+
![Recce Checklist](../assets/images/features/checklist.png)
1414
<figcaption>Checklist</figcaption>
1515
</figure>

docs/features/column-level-lineage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Common use-cases for column-level lineage are
1515

1616
1. Select a node in the lineage DAG, then click the **eye** icon next to the column you want to view.
1717

18-
![alt text](../../assets/images/features/cll-1.png){: .shadow}
18+
![alt text](../assets/images/features/cll-1.png){: .shadow}
1919

2020
1. The column-level lineage for the selected column will be displayed.
2121

22-
![alt text](../../assets/images/features/cll-2.png){: .shadow}
22+
![alt text](../assets/images/features/cll-2.png){: .shadow}
2323

2424
## Transformation Types
2525

docs/features/lineage.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ It's from the Lineage Diff that you will determine which models to investigate f
1111

1212

1313
<figure markdown>
14-
![Recce Lineage Diff](../../assets/images/features/lineage-diff.gif){: .shadow}
14+
![Recce Lineage Diff](../assets/images/features/lineage-diff.gif){: .shadow}
1515
<figcaption>Lineage Diff</figcaption>
1616
</figure>
1717

1818

1919
### Node Summary
20-
![](../../assets/images/features/node.png){: .shadow}
20+
![](../assets/images/features/node.png){: .shadow}
2121

2222
Models are color-coded to indicate their **status**:
2323

@@ -28,14 +28,14 @@ Models are color-coded to indicate their **status**:
2828
The two icons at the bottom right of each node indicate if a `row count` or `schema` change has been detected. Grayed out icons indicate no change.
2929

3030
<figure markdown>
31-
![Model with Schema Change detected](../../assets/images/features/model-schema-change-detected.png){: .shadow}
31+
![Model with Schema Change detected](../assets/images/features/model-schema-change-detected.png){: .shadow}
3232
<figcaption>Model with Schema Change detected</figcaption>
3333
</figure>
3434

3535
**Note**: A row count changed icon is only shown if there is row count diff executed on this node.
3636

3737
<figure markdown>
38-
![Open node details panel](../../assets/images/features/node-details-panel.gif){: .shadow}
38+
![Open node details panel](../assets/images/features/node-details-panel.gif){: .shadow}
3939
<figcaption>Open the node details panel</figcaption>
4040
</figure>
4141

@@ -59,7 +59,7 @@ Click a node to select it, or click the **Select nodes** button at the top-righ
5959

6060
A row count diff can be performed on nodes selected using the `select` and `exclude` options:
6161

62-
![](../../assets/images/features/row-count-diff-selector.gif){: .shadow}
62+
![](../assets/images/features/row-count-diff-selector.gif){: .shadow}
6363

6464

6565
After selecting nodes, run the row count diff by:
@@ -81,13 +81,13 @@ Schema Diff shows added, removed, and renamed columns. Click a model in the Line
8181

8282

8383
<figure markdown>
84-
![Recce Schema Diff](../../assets/images/features/schema-diff.gif){: .shadow}
84+
![Recce Schema Diff](../assets/images/features/schema-diff.gif){: .shadow}
8585
<figcaption>Schema Diff</figcaption>
8686
</figure>
8787

8888

8989
<figure markdown>
90-
![Recce Schema Diff](../../assets/images/features/schema-diff.png)
90+
![Recce Schema Diff](../assets/images/features/schema-diff.png)
9191
<figcaption>Schema Diff showing renamed column</figcaption>
9292
</figure>
9393

@@ -101,15 +101,15 @@ Row Count Diff shows the difference in row count between the base and current en
101101
3. Click `Row Count Diff`.
102102

103103
<figure markdown>
104-
![Recce Row Count Diff - Single model](../../assets/images/features/row-count-diff-single.gif){: .shadow}
104+
![Recce Row Count Diff - Single model](../assets/images/features/row-count-diff-single.gif){: .shadow}
105105
<figcaption>Row Count Diff - Single model</figcaption>
106106
</figure>
107107

108108
### Code Diff
109109

110110
Code Diff shows the model code that has changed for a particular model.
111111

112-
![Code diff](../../assets/images/features/code-diff.png)
112+
![Code diff](../assets/images/features/code-diff.png)
113113

114114
1. Click the model in the Lineage DAG.
115115
2. Click the `Explore Change` button in the node details panel.
@@ -123,7 +123,7 @@ The primary key is automatically inferred by the first column with the [unique](
123123

124124

125125
<figure markdown>
126-
![Recce Value Diff](../../assets/images/features/value-diff.png)
126+
![Recce Value Diff](../assets/images/features/value-diff.png)
127127
<figcaption>Value Diff</figcaption>
128128
</figure>
129129

@@ -145,7 +145,7 @@ The primary key is automatically inferred by the first column with the [unique](
145145

146146
View mismatched values at the row level by clicking the `show mismatched values` option on a column name:
147147

148-
![](../../assets/images/features/value-diff-detail.gif){: .shadow}
148+
![](../assets/images/features/value-diff-detail.gif){: .shadow}
149149

150150
### Profile Diff
151151

@@ -157,7 +157,7 @@ Profile Diff compares the basic statistic (e.g. count, distinct count, min, max,
157157

158158

159159
<figure markdown>
160-
![Recce Profile Diff](../../assets/images/features/profile-diff.png)
160+
![Recce Profile Diff](../assets/images/features/profile-diff.png)
161161
<figcaption>Profile Diff</figcaption>
162162
</figure>
163163

@@ -177,7 +177,7 @@ Please refer to the [dbt-profiler](https://hub.getdbt.com/data-mie/dbt_profiler/
177177
Histogram Diff compares the distribution of a numeric column in an overlay histogram chart.
178178

179179
<figure markdown>
180-
![Recce Histogram Diff](../../assets/images/features/histogram-diff.png)
180+
![Recce Histogram Diff](../assets/images/features/histogram-diff.png)
181181
<figcaption>Histogram Diff</figcaption>
182182
</figure>
183183

@@ -201,7 +201,7 @@ A Histogram Diff can be generated in two ways.
201201

202202

203203
<figure markdown>
204-
![Generate a Recce Histogram Diff ](../../assets/images/features/histogram-diff.gif){: .shadow}
204+
![Generate a Recce Histogram Diff ](../assets/images/features/histogram-diff.gif){: .shadow}
205205
<figcaption>Generate a Recce Histogram Diff from the column options</figcaption>
206206
</figure>
207207

@@ -211,7 +211,7 @@ A Histogram Diff can be generated in two ways.
211211
Top-K Diff compares the distribution of a categorical column. The top 10 elements are shown by default, which can be expanded to the top 50 elements.
212212

213213
<figure markdown>
214-
![Recce Top-K Diff](../../assets/images/features/top-k-diff.png)
214+
![Recce Top-K Diff](../assets/images/features/top-k-diff.png)
215215
<figcaption>Recce Top-K Diff</figcaption>
216216
</figure>
217217

@@ -236,7 +236,7 @@ A Top-K Diff can be generated in two ways.
236236

237237

238238
<figure markdown>
239-
![Generate a Recce Top-K Diff ](../../assets/images/features/top-k-diff.gif){: .shadow}
239+
![Generate a Recce Top-K Diff ](../assets/images/features/top-k-diff.gif){: .shadow}
240240
<figcaption>Generate a Recce Top-K Diff </figcaption>
241241
</figure>
242242

@@ -251,7 +251,7 @@ Multiple nodes can be selected in the Lineage DAG. This enables actions to be pe
251251
To select multiple nodes individually, click the check box on the nodes you wish to select.
252252

253253
<figure markdown>
254-
![Select multiple nodes individually](../../assets/images/features/multi-node-selection.gif){: .shadow}
254+
![Select multiple nodes individually](../assets/images/features/multi-node-selection.gif){: .shadow}
255255
<figcaption>Select multiple nodes individually</figcaption>
256256
</figure>
257257

@@ -264,7 +264,7 @@ To select a node and all of its parents or children:
264264
3. Click to select either parent or child nodes.
265265

266266
<figure markdown>
267-
![Select a node and its parents or children](../../assets/images/features/select-node-children.gif){: .shadow}
267+
![Select a node and its parents or children](../assets/images/features/select-node-children.gif){: .shadow}
268268
<figcaption>Select a node and its parents or children</figcaption>
269269
</figure>
270270

@@ -273,7 +273,7 @@ To select a node and all of its parents or children:
273273
After selecting the desired nodes, use the Actions menu at the top right of the screen to perform diffs or add checks.
274274

275275
<figure markdown>
276-
![Perform actions on multiple nodes](../../assets/images/features/actions-menu.png){: .shadow}
276+
![Perform actions on multiple nodes](../assets/images/features/actions-menu.png){: .shadow}
277277
<figcaption>Perform actions on multiple nodes</figcaption>
278278
</figure>
279279

@@ -282,7 +282,7 @@ After selecting the desired nodes, use the Actions menu at the top right of the
282282
An example of selecting multiple nodes to perform a multi-node row count diff:
283283

284284
<figure markdown>
285-
![Perform a Row Count Diff on multiple nodes](../../assets/images/features/multi-node-row-count-diff.gif){: .shadow}
285+
![Perform a Row Count Diff on multiple nodes](../assets/images/features/multi-node-row-count-diff.gif){: .shadow}
286286
<figcaption>Perform a Row Count Diff on multiple nodes</figcaption>
287287
</figure>
288288

@@ -291,7 +291,7 @@ An example of selecting multiple nodes to perform a multi-node row count diff:
291291
An example of selecting multiple nodes to perform a multi-node Value Diff:
292292

293293
<figure markdown>
294-
![Perform a Value Diff on multiple nodes](../../assets/images/features/multi-node-value-diff.gif){: .shadow}
294+
![Perform a Value Diff on multiple nodes](../assets/images/features/multi-node-value-diff.gif){: .shadow}
295295
<figcaption>Perform a Value Diff on multiple nodes</figcaption>
296296
</figure>
297297

@@ -302,7 +302,7 @@ An example of selecting multiple nodes to perform a multi-node Value Diff:
302302
In the diff result, we can find a **Copy to Clipboard** button. it's a handy feature to copy the result image to clipboard and paste in your PR comment.
303303

304304
<figure markdown>
305-
![Copy a diff screenshot to the clipboard - Multiple models](../../assets/images/features/clipboard-to-github.gif){: .shadow}
305+
![Copy a diff screenshot to the clipboard - Multiple models](../assets/images/features/clipboard-to-github.gif){: .shadow}
306306
<figcaption>Copy a diff result screenshot to the clipboard and paste to GitHub</figcaption>
307307
</figure>
308308

@@ -326,7 +326,7 @@ From the Lineage DAG, click the Actions dropdown menu and click Lineage Diff or
326326
- Schema Diff: A diff of all nodes if none are selected, or specific <a href="#multi-node-selection">selected nodes</a>.
327327

328328
<figure markdown>
329-
![Add a Lineage Diff Check or Schema Check via the Actions dropdown menu](../../assets/images/features/actions-dropdown.png){: .shadow}
329+
![Add a Lineage Diff Check or Schema Check via the Actions dropdown menu](../assets/images/features/actions-dropdown.png){: .shadow}
330330
<figcaption>Add a Lineage Diff Check or Schema Check via the Actions dropdown menu</figcaption>
331331
</figure>
332332

@@ -335,14 +335,14 @@ From the Lineage DAG, click the Actions dropdown menu and click Lineage Diff or
335335
For the majority of diffs, which are performed via the Explore Change dropdown menu, the Check can be added by clicking the Add to Checklist button in the results panel:
336336

337337
<figure markdown>
338-
![Add a Check by clicking the Add to Checklist button in the diff results panel](../../assets/images/features/add-to-checklist-button.png){: .shadow}
338+
![Add a Check by clicking the Add to Checklist button in the diff results panel](../assets/images/features/add-to-checklist-button.png){: .shadow}
339339
<figcaption>Add a Check by clicking the Add to Checklist button in the diff results panel</figcaption>
340340
</figure>
341341

342342

343343
An example performing a Top-K diff and adding the results to the Checklist:
344344

345345
<figure markdown>
346-
![Example adding a Top-K Diff to the Checklist](../../assets/images/features/add-to-checklist.gif){: .shadow}
346+
![Example adding a Top-K Diff to the Checklist](../assets/images/features/add-to-checklist.gif){: .shadow}
347347
<figcaption>Example adding a Top-K Diff to the Checklist</figcaption>
348348
</figure>

docs/features/node-selection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In addition to lineage diff, other types of diff also support node selection. Yo
3535
- Row count diff
3636
- Schema diff
3737

38-
![](../../assets/images/features/node-selection.png){: .shadow}
38+
![](../assets/images/features/node-selection.png){: .shadow}
3939

4040
## Limitation
4141

docs/features/preset-checks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Preset checks can be the fixed checks that are generated every time a new Recce
1313
To configure the preset checks, add the settings to the [recce config file](../reference/configuration.md).
1414

1515
1. Add a check to your checklist
16-
![alt text](../../assets/images/features/preset-checks-prep.png){: .shadow}
16+
![alt text](../assets/images/features/preset-checks-prep.png){: .shadow}
1717
2. Open the menu for the check and select **Get Preset Check Template**.
1818
3. Copy the yaml config from the dialog
19-
![alt text](../../assets/images/features/preset-checks-template.png){: .shadow}
19+
![alt text](../assets/images/features/preset-checks-template.png){: .shadow}
2020

2121
4. Paste the config into the `recce.yml` file located at the root of the project:
2222

@@ -42,7 +42,7 @@ To configure the preset checks, add the settings to the [recce config file](../r
4242
### Recce Server
4343
4444
1. When a new Recce instance is launched, all preset checks are automatically set up, but these checks are not executed at this time.
45-
![alt text](../../assets/images/features/preset-checks.png){: .shadow}
45+
![alt text](../assets/images/features/preset-checks.png){: .shadow}
4646
2. When the **Run Query** button is pressed, the check will be executed.
4747
4848
### Recce Run

docs/features/query.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ select * from {{ ref("mymodel") }}
2424

2525
If the primary key(s) is specified, the query will occur in the warehouse; otherwise, the query will happen across two environments and the comparison will take place on the client side.
2626

27-
![Recce Query Diff](../../assets/images/features/query-diff.png)
27+
![Recce Query Diff](../assets/images/features/query-diff.png)
2828

2929
!!! tip
3030

3131
In Mac, you can use `⌘ Enter` to run a query or use `⌘ ⇧ Enter` to run a query diff.
3232

3333
## Query Result
3434

35-
![Recce Query Diff](../../assets/images/features/query-diff.gif){: .shadow}
35+
![Recce Query Diff](../assets/images/features/query-diff.gif){: .shadow}
3636

3737
- **Primary Key:** When comparison occurs on the client side, we can select the primary key by clicking the `key` icon. The primary key columns are used to be identified as the same record for both sides. If no primary key is specified, the records is compared by the row's index.
3838
- **Pinned Column:** The pinned column would show first in the column list.

docs/features/state-file.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ There are multiple ways to save the state file.
1919
1. **Save from the Web UI**: Click the **Save** button at the top of the app. Recce will continuously write updates to the state file, effectively working like an auto-save feature, and persist the state until the Recce instance is closed. The file is saved with the specified filename in the directory where the recce server command is run.
2020

2121
1. **Export from the Web UI**: Click the **Export** button located in the top-right corner to download the current Recce state to any location on your machine.
22-
![](../../assets/images/features/state-file-save.png){: .shadow}
22+
![](../assets/images/features/state-file-save.png){: .shadow}
2323

2424
1. **Start Recce from a State File**: You can provide a state file as an argument when launching Recce. If the file does not exist, Recce will create a state file and start with an empty state. If the file exists, Recce will load the state and continue working from it.
2525
```
@@ -68,7 +68,7 @@ Common development workflow:
6868
recce server recce_issue_1.json
6969
```
7070
71-
![State File For Development](../../assets/images/features/state-file-dev.png)
71+
![State File For Development](../assets/images/features/state-file-dev.png)
7272
7373
## Scenario: PR Review
7474
@@ -87,7 +87,7 @@ During the PR review process, the state file serves as a communication medium be
8787
recce server --review recce_issue_1.json
8888
```
8989
90-
![State File For PR Review](../../assets/images/features/state-file-pr.png)
90+
![State File For PR Review](../assets/images/features/state-file-pr.png)
9191
9292
## Recce Cloud
9393

docs/get-started-jaffle-shop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ icon: material/school
6666
recce server
6767
```
6868
Open the link http://0.0.0.0:8000, you can see the lineage diff
69-
![](../assets/images/jaffle-shop/jaffle_shop_lineage.png)
69+
![](assets/images/jaffle-shop/jaffle_shop_lineage.png)
7070
1. Switch to the **Query** tab, run this query
7171
```sql
7272
select * from {{ ref("orders") }} order by 1
7373
```
7474
Click the `Run Diff` or press `Cmd + Shift + Enter`
7575
Click on the 🔑 icon next to the `order_id` column to compare records that are uniquely identified by their `order_id`.
76-
![](../assets/images/jaffle-shop/jaffle_shop_query.png)
76+
![](assets/images/jaffle-shop/jaffle_shop_query.png)
7777
1. Click the `+` to add the query result to checklist
78-
![](../assets/images/jaffle-shop/jaffle_shop_check.png)
78+
![](assets/images/jaffle-shop/jaffle_shop_check.png)

0 commit comments

Comments
 (0)