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.

Sign up for GitHub

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

Jump to bottom

Write blog post dbt docs in Airflow with Cosmos #1139

Open
1 task
tatiana opened this issue Aug 1, 2024 · 0 comments
Open
1 task

Write blog post dbt docs in Airflow with Cosmos #1139

tatiana opened this issue Aug 1, 2024 · 0 comments
Labels
area:docs Relating to documentation, changes, fixes, improvement dbt:docs Primarily related to dbt docs command or functionality execution:local Related to Local execution environment

Comments

@tatiana
Copy link
Collaborator

tatiana commented Aug 1, 2024

Context

Many people from the community need to realise Cosmos can host dbt docs, as implemented by @dwreeves in #737.

The goal of this blog post is to give visibility to this feature. Check with @dwreeves if he'd like to author or co-author this.

Some possible topics that could be covered:

Acceptance criteria

  • Publish the blog post
@dosubot dosubot bot added area:docs Relating to documentation, changes, fixes, improvement dbt:docs Primarily related to dbt docs command or functionality execution:local Related to Local execution environment labels Aug 1, 2024
@tatiana tatiana mentioned this issue Aug 1, 2024
Open
@johnmcochran johnmcochran mentioned this issue Oct 10, 2024
Merged
1 task
tatiana pushed a commit that referenced this issue Oct 11, 2024
@johnmcochran
Improve dbt Docs Hosting Debugging -- Update dbt_docs_not_set_up.html (…
2dd8c7a 
…#1250)

## 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:docs Relating to documentation, changes, fixes, improvement dbt:docs Primarily related to dbt docs command or functionality execution:local Related to Local execution environment
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tatiana