-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
simplify prepare_if_dev
explanation in dbt tutorial
#23765
Conversation
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-m192zzgqc-elementl.vercel.app Direct link to changed pages: |
@maximearmstrong @erinkcochran87 - mind taking a look at this one? |
|
||
In this tutorial, we're going with the first option: We run `dagster dev` and use `dbt_project.prepare_if_dev()` to prepare the dbt project and create the manifest. | ||
However, in development, when you're iteratively making changes to files inside your dbt project and seeing what effects they have, you typically want those changes to be reflected in your local Dagster UI ASAP, without requiring you to explicitly re-generate the manifest. `dbt_project.prepare_if_dev()` helps with this – it re-generates your `manifest.json` at the time Dagster imports your code, _but_ only if it's being imported by the `dagster dev` command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, in development, when you're iteratively making changes to files inside your dbt project and seeing what effects they have, you typically want those changes to be reflected in your local Dagster UI ASAP, without requiring you to explicitly re-generate the manifest. `dbt_project.prepare_if_dev()` helps with this – it re-generates your `manifest.json` at the time Dagster imports your code, _but_ only if it's being imported by the `dagster dev` command. | |
However, in development, you typically want changes made to files in your dbt project to be immediately reflected in the Dagster UI without needing to regenerate the manifest. | |
`dbt_project.prepare_if_dev()` helps with this – it re-generates your `manifest.json` at the time Dagster imports your code, but only if it's being imported by the `dagster dev` command. |
I think we can tighten this up more
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 good point, made this change
0707b4b
to
b03ce04
Compare
Summary & Motivation
The dbt tutorial explains
prepare_if_dev
in a couple different ways, and I think it could get the same info across with a bit less.How I Tested These Changes