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

Update explore-projects.md #5560

Merged
merged 14 commits into from
May 29, 2024
Merged
Changes from 2 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
8 changes: 5 additions & 3 deletions website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,17 @@ With dbt Explorer, you can view your project's [resources](/docs/build/projects)

- You have a dbt Cloud account on the [Team or Enterprise plan](https://www.getdbt.com/pricing/).
- You have set up a [production](/docs/deploy/deploy-environments#set-as-production-environment) or [staging](/docs/deploy/deploy-environments#create-a-staging-environment) deployment environment for each project you want to explore.
- There has been at least one successful job run in the deployment environment.
- There has been at least one successful job run in the deployment environment. Note, [Continuous integration (CI) jobs](/docs/deploy/ci-jobs) don't update dbt Explorer.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- You are on the dbt Explorer page. To do this, select **Explore** from the top navigation bar in dbt Cloud.


## Generate metadata

dbt Explorer uses the metadata provided by the [Discovery API](/docs/dbt-cloud-apis/discovery-api) to display the details about [the state of your project](/docs/dbt-cloud-apis/project-state). The metadata that's available depends on the [deployment environment](/docs/deploy/deploy-environments) you've designated as _production_ or _staging_ in your dbt Cloud project. dbt Explorer automatically retrieves the metadata updates after each job run in the production or staging deployment environment so it always has the latest results for your project.

To view a resource and its metadata, you must define the resource in your project and run a job in the production or staging environment. The resulting metadata depends on the [commands](/docs/deploy/job-commands) executed by the jobs.
Note: [CI jobs](/docs/deploy/ci-jobs) don't update dbt Explorer because they don't reflect the production state or provide the necessary metadata updates.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved

To view a resource and its metadata, you must define the resource in your project and run a job in the production or staging environment. The resulting metadata depends on the [commands](/docs/deploy/job-commands) executed by the jobs.

| To view in Explorer | You must successfully run |
|---------------------|---------------------------|
Expand All @@ -31,7 +33,7 @@ To view a resource and its metadata, you must define the resource in your projec
| Snapshot details | [dbt snapshot](/reference/commands/snapshot) or [dbt build](/reference/commands/build) within a job in the environment |
| Seed details | [dbt seed](/reference/commands/seed) or [dbt build](/reference/commands/build) within a job in the environment |

Richer and more timely metadata will become available as dbt Core, the Discovery API, and the underlying dbt Cloud platform evolves.
Richer and more timely metadata will become available as dbt Cloud evolves.

## Explore your project's lineage graph {#project-lineage}

Expand Down
Loading