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 dbt Docs with improvements to Metric documentation #5438

Closed
wants to merge 2 commits into from

Conversation

drewbanin
Copy link
Contributor

@drewbanin drewbanin commented Jul 5, 2022

Description

This PR adds a new build of the dbt-docs index.html file via dbt-labs/dbt-docs#285. Specifically, it includes improvements to how metrics are referenced in the Docs UX and DAG viz. It:

  • Draws DAG edges for expression metrics (ie. a metric that depends on one or more other metrics)
  • Renders labels, types (expression vs. aggregate), and SQL for each metric
  • Uses the metric label rather than the name in the sidebar + DAG viz + search results
  • Supports search results on metric + label name (eg. both "arpc" and "Revenue") should pull up the arpc metric

image

image

Checklist

@drewbanin drewbanin requested a review from a team as a code owner July 5, 2022 18:47
@drewbanin drewbanin requested review from nathaniel-may and stu-k July 5, 2022 18:47
@cla-bot cla-bot bot added the cla:yes label Jul 5, 2022
@drewbanin drewbanin changed the title Add new index.html via https://github.com/dbt-labs/dbt-docs/pull/285 Update dbt Docs index.html with improvements to Metric documentation Jul 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@drewbanin drewbanin changed the title Update dbt Docs index.html with improvements to Metric documentation Update dbt Docs with improvements to Metric documentation Jul 5, 2022
@drewbanin
Copy link
Contributor Author

oops - closing in favor of #5255

@drewbanin drewbanin closed this Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant