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

Explorer update: column level lineage #4767

Closed
wants to merge 12 commits into from
Closed

Conversation

nghi-ly
Copy link
Contributor

@nghi-ly nghi-ly commented Jan 18, 2024

What are you changing in this pull request and why?

Create subpage for new column level lineage feature in dbt Explorer.

New page:

  • /docs/collaborate/column-level-lineage

Updated page:

  • Project recommendations -- Improved SEO by moving callout that was at the beginning of the page to some place a little lower

Cleaned up (removed) unused files:

  • catalog-sidebar-v1.gif
  • lineage-v1.gif
  • model-resource-details-v1.gif
  • search-v1.gif

Checklist

Adding or removing pages (delete if not applicable):

  • Add/remove page in website/sidebars.js
  • Provide a unique filename for new pages
  • Add an entry for deleted pages in website/static/_redirects
  • Run link testing locally with npm run build to update the links that point to deleted pages

@nghi-ly nghi-ly requested a review from a team as a code owner January 18, 2024 00:24
Copy link

vercel bot commented Jan 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 19, 2024 8:03pm

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Jan 18, 2024
Column level lineage is available to dbt Cloud Enterprise accounts that can use Explorer. It’s also available through the Discovery API.

:::tip Beta
Column-level lineage is now available in beta. Check it out! We'd love to [know what you think](https://docs.google.com/forms/d/e/1FAIpQLSdpCbVkGY9QwfExFonpWE4DTOKi3fQxBGLD0wwKYpkMjgcE7g/viewform)!
Copy link
Contributor Author

Choose a reason for hiding this comment

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

i didn't use "open beta" here, aligned with the betas for Project recs and Model perf pages. lemme know if this doesn't work tho! happy to change


- **Parsing error** — Error occurs when the SQL is ambiguous or too complex for parsing. An example of ambiguous parsing scenarios are _complex_ lateral joins.
- **Python error** — Error occurs when a Python model is used within the lineage. Due to the nature of Python models, it's not possible to parse and determine the lineage.
- **Unknown error** — Error occurs when the lineage can't be determined for an unknown reason. An example of this would be if a dbt best practice is not being followed, like using hardcoded table names instead of `ref` statements.
Copy link
Contributor Author

@nghi-ly nghi-ly Jan 18, 2024

Choose a reason for hiding this comment

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

"improper use of dbt" read a bit strong to me so trying this wording instead. this might be a bit of a mouthful tho


The project recommendations beta feature is now available in dbt Explorer! Check it out!

:::
Copy link
Contributor Author

Choose a reason for hiding this comment

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

callouts at the top of pages affect SEO so as a best practice we're moving them to a lower location on the page but making sure they're still before the fold


<Lightbox src="/img/docs/collaborate/dbt-explorer/example-cll.png" title="Example of the Columns tab and where to expand for the CLL"/>

<LoomVideo id='278c948ba387457884cc6b9545793685' />
Copy link
Contributor Author

@nghi-ly nghi-ly Jan 18, 2024

Choose a reason for hiding this comment

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

@dave-connors-3 : i'm using the loom video from the notion draft. we can update the link if you end up rerecording it, np

Copy link
Contributor

Choose a reason for hiding this comment

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

@dave-connors-3 feel free to re-record, maybe on Fri or Mon? i'd like to see your take, and we may want to wait for more UX improvements to land

website/docs/docs/collaborate/column-level-lineage.md Outdated Show resolved Hide resolved
website/docs/docs/collaborate/column-level-lineage.md Outdated Show resolved Hide resolved

## What you can use column level lineage for {#use-cases}

Click on these tabs to learn more about the CLL use cases, the analysis you can do, and the results you can achieve:
Copy link
Contributor

Choose a reason for hiding this comment

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

Explore the sections below to learn more about why and how you can use column-level lineage.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated this. for accessibility, "below" is not a great word choice so worked around that

website/docs/docs/collaborate/column-level-lineage.md Outdated Show resolved Hide resolved
<TabItem value="collaboration" label="Collaboration and efficiency">

When exploring your data products, navigating column lineage allows analytics engineers and data analysts to more easily navigate and understand the origin and usage of their data, enabling them to make better decisions with higher confidence.
</TabItem>
Copy link
Contributor

Choose a reason for hiding this comment

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

Another use case - thoughts @dave-connors-3 ?

Auditing

Column-level awareness makes it easier for data developers to see how columns flow through the project when examining how data is used in a dbt project.


<Lightbox src="/img/docs/collaborate/dbt-explorer/example-cll.png" title="Example of the Columns tab and where to expand for the CLL"/>

<LoomVideo id='278c948ba387457884cc6b9545793685' />
Copy link
Contributor

Choose a reason for hiding this comment

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

@dave-connors-3 feel free to re-record, maybe on Fri or Mon? i'd like to see your take, and we may want to wait for more UX improvements to land

website/docs/docs/collaborate/column-level-lineage.md Outdated Show resolved Hide resolved

<LoomVideo id='278c948ba387457884cc6b9545793685' />

## Column level lineage use cases {#use-cases}
Copy link
Contributor Author

@nghi-ly nghi-ly Jan 19, 2024

Choose a reason for hiding this comment

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

updated heading title so it shows up higher (ie "weighted" more) in our search list as well as having a tidy URL. here's a comparison where the "distinct" example is at the top of the search list:

Screenshot 2024-01-19 at 8 51 40 AM
Screenshot 2024-01-19 at 8 52 27 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto update content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants