Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html#1250
Merged
Conversation
dbt_docs_dir is None directly triggers the dbt_docs_net_set_up.html page via the plugin. I had a hard time figuring out why my dbt docs were not set up yet considering I had (incorrectly) tried setting up the dbt_docs_dir variable via the Airflow UI. Adding a note that the dbt_docs_dir was not found would make this error page much more helpful from a debugging standpoint.
✅ Deploy Preview for sunny-pastelito-5ecb04 canceled.
|
tatiana
approved these changes
Oct 11, 2024
tatiana
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for the detailed description and for improving this part of Cosmos, @johnmcochran ! It's a valuable contribution.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1250 +/- ##
=======================================
Coverage 95.73% 95.73%
=======================================
Files 67 67
Lines 3965 3965
=======================================
Hits 3796 3796
Misses 169 169 ☔ View full report in Codecov by Sentry. |
tatiana
added a commit
that referenced
this pull request
Oct 29, 2024
Bug fixes * Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252 * Fix displaying dbt docs as menu item in Astro by @tatiana in #1280 * Fix: Replace login by user for clickhouse profile by @petershenri in #1255 Enhancements * Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250 * Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253 Docs * Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251 * Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283 * Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256 Others * Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284 * Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282 * Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275 * Pre-commit hook updates in #1285, #1274, #1254, #1244" error: pathspec 'Is' did not match any file(s) known to git error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251 * Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283 * Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256 Others * Update CODEOWNERS to track all files by @pankajkoti in #1284 * Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282 * Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275 * Pre-commit hook updates in #1285, #1274, #1254, #1244
Merged
tatiana
added a commit
that referenced
this pull request
Oct 29, 2024
Bug fixes * Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by kesompochy in #1252 * Fix displaying dbt docs as menu item in Astro by @tatiana in #1280 * Fix: Replace login by user for clickhouse profile by @petershenri in #1255 Enhancements * Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250 * Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253 Docs * Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251 * Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283 * Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256 Others * Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284 * Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282 * Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275 * Pre-commit hook updates in #1285, #1274, #1254, #1244" error: pathspec 'Is' did not match any file(s) known to git error: pathspec 'Cosmos Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251 * Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283 * Add dedicated scarf tracking pixel to readme by @cmarteepants in #1256 Others * Update CODEOWNERS to track all files by @pankajkoti in #1284 * Fix release after the raw rst directive disabled was disabled in PyPI by @tatiana in #1282 * Update issue template bug.yml - cosmos version update in the dropdown by @pankajkoti in #1275 * Pre-commit hook updates in #1285, #1274, #1254, #1244
tatiana
added a commit
that referenced
this pull request
Oct 29, 2024
Bug fixes * Fix ``DbtVirtualenvBaseOperator`` to use correct virtualenv Python path by @kesompochy in #1252 * Fix displaying dbt docs as menu item in Astro by @tatiana in #1280 * Fix: Replace login by user for clickhouse profile by @petershenri in #1255 Enhancements * Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html by @johnmcochran in #1250 * Minor refactor on VirtualenvOperators & add test for PR by @tatiana in #1253 Docs * Add Welcome Section and "What Is Cosmos" Blurb to Home Page by @cmarteepants and @yanmastin-astro in #1251 * Update the URL for sample dbt docs hosted in Astronomer S3 bucket by @pankajkoti in #1283 * Add a dedicated scarf tracking pixel to readme by @cmarteepants in #1256 Others * Update ``CODEOWNERS`` to track all files by @pankajkoti in #1284 * Fix release after the ``raw`` rst directive disabled was disabled in PyPI by @tatiana in #1282 * Update issue template ``bug.yml`` - cosmos version update in the dropdown by @pankajkoti in #1275 * Pre-commit hook updates in #1285, #1274, #1254, #1244
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
[ dbt_docs_dir is None ] directly triggers the [ dbt_docs_net_set_up.html ] page via the cosmos plugin. I had a hard time figuring out why my dbt docs weren't hosting properly considering I had (incorrectly) tried setting up the dbt_docs_dir variable via the Airflow UI. Once I added the environment variable to my Dockerfile, the dbt Docs showed correctly in the airflow UI. I had to inspect the source code for the plugin to find out that cosmos was not correctly seeing the environment variables I had set up.
Adding a note that the "dbt_docs_dir was not found" would make this error page much more helpful from a debugging standpoint for me.
Related Issue(s)
Related to #1245: Make it easier for end-users to create a DAG for creating/hosting dbt docs
Related to #1139: Write blog post dbt docs in Airflow with Cosmos
Breaking Change?
This is my first time creating a PR on a public github, but I think this is as low impact as you can get :)
Checklist
I don't know how to test this :( Just trying to save others some time if they have the same problem I had with correctly hosting dbt docs.