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.

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

Add Documentation for Conditional Dataset Scheduling with dag-factory #367

Merged
merged 7 commits into from
Jan 17, 2025

Conversation

ErickSeo
Copy link
Contributor

@ErickSeo ErickSeo commented Jan 15, 2025

Closes: #361

This PR adds a comprehensive guide on conditional dataset scheduling using dag-factory (v0.22.0+) and Airflow 2.9+. Key updates include:

Explanation of conditional dataset scheduling and its use cases.
Requirements for using the feature.
Examples demonstrating configurations with both string and YAML syntax.
Visual diagrams illustrating dataset condition logic.
This documentation is intended to help users understand and implement conditional dataset scheduling effectively in their workflows.

ErickSeo added 2 commits January 15, 2025 10:44
- Add conditional dataset images
- Add Conditional Dataset Scheduling
@codecov-commenter
Copy link

codecov-commenter commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.01%. Comparing base (98fffa2) to head (90ae2e6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #367   +/-   ##
=======================================
  Coverage   94.01%   94.01%           
=======================================
  Files          11       11           
  Lines         886      886           
=======================================
  Hits          833      833           
  Misses         53       53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@tatiana tatiana left a comment

Choose a reason for hiding this comment

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

This looks great, thanks a lot, @ErickSeo , for follow up on the documentation!

@tatiana tatiana requested a review from a team January 16, 2025 10:40
@tatiana tatiana added this to the DAG Factory 0.23.0 milestone Jan 16, 2025
Copy link
Contributor

@yanmastin-astro yanmastin-astro left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@pankajastro pankajastro left a comment

Choose a reason for hiding this comment

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

We want to clean REAME file. I know the dataset feature we have not documented yet but I'm wondering if it makes sense to move this changes in /docs folder so that would be appear in our main docs: https://astronomer.github.io/dag-factory/latest/ ?

@ErickSeo
Copy link
Contributor Author

ErickSeo commented Jan 16, 2025

I'm going to move the documentation from the README to the docs folder.
Would it make sense to clean up the entire section referencing the dataset from the README and move it to the docs as well?

@pankajastro
Copy link
Collaborator

Would it make sense to clean up the entire section referencing the dataset from the README and move it to the docs as well?

Yes, if you can do this, it would be great.

@ErickSeo
Copy link
Contributor Author

Captura de tela 2025-01-16 192737
Captura de tela 2025-01-16 193136

@pankajastro pankajastro merged commit de032dc into astronomer:main Jan 17, 2025
68 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for new scheduling feature
5 participants