-
Notifications
You must be signed in to change notification settings - Fork 251
Fix minor documentation typo #2093
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
base: main
Are you sure you want to change the base?
Conversation
| from cosmos.operators import DbtDocsGCSOperator | ||
| # then, in your DAG code: | ||
| generate_dbt_docs_aws = DbtDocsGCSOperator( |
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.
Thanks for fixing this, @dnskr.
I strongly suggest that instead of hard-coding this here, that we reference an example code that is being run as part of Cosmos' CI:
https://github.com/astronomer/astronomer-cosmos/blob/main/dev/dags/cosmos_manifest_example.py#L76-L88
Using the same pattern as:
astronomer-cosmos/docs/getting_started/watcher-execution-mode.rst
Lines 104 to 107 in d76bae0
| .. literalinclude:: ../../dev/dags/example_watcher.py | |
| :language: python | |
| :start-after: [START example_watcher] | |
| :end-before: [END example_watcher] |
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.
I think the following DAG and code should be used as a docs generation example:
astronomer-cosmos/dev/dags/dbt_docs.py
Lines 64 to 71 in db76233
| generate_dbt_docs_gcs = DbtDocsGCSOperator( | |
| task_id="generate_dbt_docs_gcs", | |
| project_dir=DBT_ROOT_PATH / "jaffle_shop", | |
| profile_config=profile_config, | |
| connection_id="gcp_gs_conn", | |
| bucket_name="cosmos-ci-docs", | |
| install_deps=True, | |
| ) |
Also, the changes should be applied to the AWS and Azure examples for consistency.
However, the DAG code does not fully match existing example code. Would you like me to make the changes or should I leave it as is?
✅ Deploy Preview for sunny-pastelito-5ecb04 canceled.
|
Description
Fix minor typo in the documentation.
Breaking Change?
No
Checklist