Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add trust signals to explorer #6141

Merged
merged 21 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1e16003
trust signals
mirnawong1 Sep 25, 2024
ef7f644
add pill
mirnawong1 Sep 25, 2024
b9a7cd3
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 25, 2024
2ec136f
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 26, 2024
2a4624c
add imgs
mirnawong1 Sep 26, 2024
c2aa158
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 26, 2024
2f724a4
fix img size
mirnawong1 Sep 26, 2024
c11dc91
Update explore-projects.md
mirnawong1 Sep 26, 2024
87c5216
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 27, 2024
b4e11cc
Update website/docs/docs/collaborate/explore-projects.md
mirnawong1 Sep 27, 2024
291c77c
Update website/docs/docs/collaborate/explore-projects.md
mirnawong1 Sep 27, 2024
d2bcaef
Update website/docs/docs/collaborate/explore-projects.md
mirnawong1 Sep 27, 2024
b89d0e6
Update website/docs/docs/collaborate/explore-projects.md
mirnawong1 Sep 27, 2024
7d8e01b
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 27, 2024
b9996d8
fold in feedback
mirnawong1 Sep 27, 2024
f46fb8b
Merge branch 'mwong-trust-signals' of github.com:dbt-labs/docs.getdbt…
mirnawong1 Sep 27, 2024
0e40822
update sources
mirnawong1 Sep 27, 2024
0c91097
update imgs
mirnawong1 Sep 27, 2024
757c6c0
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Sep 30, 2024
95cce91
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Oct 2, 2024
50e3513
Merge branch 'mwong-explorer-previews-main' into mwong-trust-signals
mirnawong1 Oct 2, 2024
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
59 changes: 56 additions & 3 deletions website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ To explore the lineage graphs of tests and macros, view [their resource details

### Example of full lineage graph

Example of exploring the `order_items` model in the project's lineage graph:
Example of exploring a model in the project's lineage graph:

<Lightbox src="/img/docs/collaborate/dbt-explorer/example-project-lineage-graph.png" width="100%" title="Example of full lineage graph" />

Expand Down Expand Up @@ -162,12 +162,64 @@ Under the the **Models** option, you can filter on model properties (access or m

</Expandable>

<Expandable alt_header="Trust signals for resources" lifecycle="preview">

Trust signal icons offer a quick, at-a-glance view of data health when browsing your models in dbt Explorer. These icons keep you informed on the status of your model's health using the indicators **Healthy**, **Caution**, **Degraded**, and **Unknown**. For accurate health data, ensure the resource is up-to-date and has had a recent job run.

Each trust signal icon reflects key data health components, such as test success status, missing resource descriptions, absence of builds in 30-day windows, and more.

To access trust signals:
- Use the search function or click on **Models** or **Sources** under the **Resource** tab.
- View the icons under the **Health** column.
- Hover over or click the trust signal to see detailed information.
- For sources, the trust signal also indicates the source freshness status.

<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-health.jpg" width="60%" title="View trust signals for your models."/>

<!-- commenting out until further iteration on the content

<Tabs>
<TabItem value="healthy" label="Healthy">
A resource is considered Healthy if it meets the following criteria:
- Ran all tests successfully
- Successfully built in its last run
- Has a description and tests configured
- Has been built in the past 30 days
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-healthy.png" title="Healthy trust signal icon"/>
</TabItem>

<TabItem value="caution" label="Caution">
Any of the following conditions can trigger a caution status:
- Successfully built in its last run
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- Is missing a description
- Does not have any tests configured
- Has not been built in the past 30 day
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-caution.png" title="Caution trust signal icon"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

We might want to get product to update the text in the screenshots because this is really confusing when it says the resource is "caution" because it successfully ran on it's last run. Are these fields dynamic - when it's caution does it change the fields that put it in caution only or does it display the same text all the time?

</TabItem>

<TabItem value="degraded" label="Degraded">
A resource is considered Degraded if it meets any of the following criteria:
- Last run failed or source freshness error
<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signals-degraded.jpg" width="35%" title="Degraded trust signal icon"/>
</TabItem>

<TabItem value="unknown" label="Unknown">
The Unknown trust signal icon indicates that:
- Health information is unknown because the resource hasn't been run recently.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is "recently" in this case? I'm assuming if the resource has never been run before (which we should mention), but in the above, not running in 30 days is a caution, so how long must it be to revert to "unknown"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Roxi addressing

<Lightbox src="/img/docs/collaborate/dbt-explorer/trust-signal-unknown.png" title="Unknown trust signal icon"/>

</TabItem>
</Tabs>

-->

</Expandable>

### Example of keyword search
Example of results from searching on the keyword `item` and applying the filters models, description, and code:
Example of results from searching on the keyword `customers` and applying the filters models, description, and code. Trust signals are visible to the right of the model name in the search results.

<Lightbox src="/img/docs/collaborate/dbt-explorer/example-keyword-search.png" width="100%" title="Example of keyword search" />


## Browse with the sidebar

From the sidebar, you can browse your project's resources, its file tree, and the database.
Expand Down Expand Up @@ -201,6 +253,7 @@ In the upper right corner of the resource details page, you can:

<Expandable alt_header="What details are available for a model?">

- Trust signal icon &mdash; Icons offering a quick, at-a-glance view of data health. These icons indicate whether a model is Healthy, Caution, Degraded, or Unknown. Hover over an icon to view detailed information about the model's health.
- **Status bar** (below the page title) &mdash; Information on the last time the model ran, whether the run was successful, how the data is materialized, number of rows, and the size of the model.
- **General** tab includes:
- **Lineage** graph &mdash; The model’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the model. Click the Expand icon in the graph's upper right corner to view the model in full lineage graph mode.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading