Skip to content

Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html#1250

Merged
tatiana merged 1 commit into
astronomer:mainfrom
johnmcochran:patch-1
Oct 11, 2024
Merged

Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html#1250
tatiana merged 1 commit into
astronomer:mainfrom
johnmcochran:patch-1

Conversation

@johnmcochran

@johnmcochran johnmcochran commented Oct 10, 2024

Copy link
Copy Markdown
Contributor

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

  • [NA ] I have made corresponding changes to the documentation (if required)
  • I have added tests that prove my fix is effective or that my feature works

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.

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.
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Oct 10, 2024
@netlify

netlify Bot commented Oct 10, 2024

Copy link
Copy Markdown

Deploy Preview for sunny-pastelito-5ecb04 canceled.

Name Link
🔨 Latest commit e1a2a34
🔍 Latest deploy log https://app.netlify.com/sites/sunny-pastelito-5ecb04/deploys/67084c7dc2d3b90008d8a626

@dosubot dosubot Bot added area:plugin Related to the Cosmos AirflowPlugin. dbt:docs Primarily related to dbt docs command or functionality labels Oct 10, 2024

@tatiana tatiana left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you for the detailed description and for improving this part of Cosmos, @johnmcochran ! It's a valuable contribution.

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Oct 11, 2024
@tatiana tatiana merged commit 2dd8c7a into astronomer:main Oct 11, 2024
@codecov

codecov Bot commented Oct 11, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.73%. Comparing base (4c4c57c) to head (e1a2a34).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@tatiana tatiana added this to the Cosmos 1.7.1 milestone Oct 25, 2024
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 tatiana mentioned this pull request Oct 29, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:plugin Related to the Cosmos AirflowPlugin. dbt:docs Primarily related to dbt docs command or functionality lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants