Add documentation to support developers by tatiana · Pull Request #343 · astronomer/dag-factory

tatiana · 2025-01-06T14:14:50Z

Add documentation to support developers, including:

Overview of how to contribute
How to set up the local development environment
Running tests
Pre-commit and linting
Authoring the documentation
Releasing

Closes: #232

codecov-commenter · 2025-01-06T14:19:17Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.68%. Comparing base (c181a5f) to head (af863fd).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #343   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files          10       10           
  Lines         792      792           
=======================================
  Hits          742      742           
  Misses         50       50

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

pankajkoti

This is a great help for contributors, thanks a lot for adding this!

LGTM, few minor cosmetic suggestions inline.

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>

lzdanski

Copyediting review

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

tatiana · 2025-01-06T16:29:24Z

Thank you so much for the thorough review and documentation lesson, @lzdanski ! I've taken notes for the following documents I do - so I can avoid the same mistakes. I addressed all the feedback.

@pankajkoti

### Added - Propagate provided dag_display_name to built dag by @pankajkoti in #326 - Add incipient documentation tooling by @tatiana in #328 - Support loading `default_args` from shared `defaults.yml` by @pankajastro in #330 - Add security policy by @tatiana in #339 - Add Robust Support for Callbacks at Task and TaskGroup Level by @@jroach-astronomer in #322 - Support `ExternalTaskSensor` `execution_date_fn` and `execution_delta` by @tatiana in #354 - Refactor and add support for schedule conditions in DAG configuration by @ErickSeo in #320 ### Fixed - Handle gracefully exceptions during telemetry collection by @tatiana in #335 - Adjust `markdownlint` configuration to enforce 4-space indentation for proper `mkdocs` rendering by @pankajkoti in #345 ### Docs - Create initial documentation index by @tatiana in #325 - Use absolute URLs for failing links in docs/index.md by @pankajkoti in #331 - Add quick start docs by @pankajastro in #324 - Add docs comparing Python and YAML-based DAGs by @tatiana in #327 - Add docs about project contributors and their roles by @tatiana in #341 - Add documentation to support developers by @tatiana in #343 - Add docs for configuring workflows, environment variables and defaults by @pankajkoti in #338 - Add code of conduct for contributors and DAG factory community by @tatiana in #340 - Document Dynamic Task Mapping feature by @pankajkoti in #344 - Fix warning message 404 in code_of_conduct docs by @pankajastro in #346 - Update theme for documentation by @pankajastro in #348 - Fix markdownlint errors and some rendering improvements by @pankajastro in #356 - Reword content in documentation by @yanmastin-astro in #336 ### Others - Improve integration tests scripts by @tatiana in #316 - Add Markdown pre-commit checks by @tatiana in #329 - Remove Airflow <> 2.0.0 check by @pankajastro in #334 - Reduce telemetry timeout from 5 to 1 second by @tatiana in #337 - Add GH action job to deploy docs by @pankajastro in #342 - Enable Depandabot to scan outdated Github Actions dependencies by @tatiana in #347 - Improve docs deploy job by @pankajastro in #352 - Unify how we build dagfactory by @tatiana in #353 - Fix running make docker run when previous versions were run locally by @tatiana in #362 - Install `jq` in `dev` container by @pankajastro in #363 - Dependabot GitHub actions version upgrades in #349, #350, #351 Closes: #306

tatiana added 3 commits January 6, 2025 14:02

Add how to contribute docs

b8ff9e5

Add how to contribute docs

365e95c

Update contributing guidelines

b6b6278

tatiana requested a review from a team as a code owner January 6, 2025 14:14

Remove 3.12 pin from Makefile

f93ff4d

tatiana added 2 commits January 6, 2025 14:22

Merge branch 'main' into contribute-docs

1d9721d

Add links to roles.md document referring the howto.md

6e2fe63

tatiana requested a review from a team January 6, 2025 14:29

pankajkoti approved these changes Jan 6, 2025

View reviewed changes

Comment thread docs/contributing/howto.md Outdated

Comment thread docs/contributing/howto.md Outdated

Comment thread docs/contributing/howto.md Outdated

tatiana and others added 3 commits January 6, 2025 16:13

Update docs/contributing/howto.md

0ba5ad9

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>

Update docs/contributing/howto.md

e50c978

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>

Update docs/contributing/howto.md

3347a4b

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>

lzdanski reviewed Jan 6, 2025

View reviewed changes

tatiana and others added 16 commits January 6, 2025 16:14

Update docs/contributing/howto.md

3795495

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

6590985

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

6a8df27

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

f921398

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

a97df08

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

7ae5621

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

9f48478

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/roles.md

5682c22

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

3d53e6b

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

7c2d21f

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

f6122da

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

b2e21dd

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

57f40f3

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

456045b

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

c349df4

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

343cbe7

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

tatiana and others added 8 commits January 6, 2025 16:18

Update docs/contributing/howto.md

2048068

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

5a4a310

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

119adf3

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

170803f

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

5d5e307

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

0dba401

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

9198680

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

Update docs/contributing/howto.md

05d1c9e

Co-authored-by: Laura Zdanski <25642903+lzdanski@users.noreply.github.com>

tatiana commented Jan 6, 2025

View reviewed changes

Comment thread docs/contributing/howto.md Outdated

Update docs/contributing/howto.md

af863fd

tatiana merged commit 70771d8 into main Jan 6, 2025

tatiana deleted the contribute-docs branch January 6, 2025 17:49

tatiana mentioned this pull request Jan 8, 2025

Create user-facing documentation for DAG Factory #278

Closed

pankajkoti mentioned this pull request Jan 10, 2025

Release 0.22.0 #360

Merged

tatiana added this to the DAG Factory 0.22.0 milestone Jan 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation to support developers#343

Add documentation to support developers#343
tatiana merged 34 commits into
mainfrom
contribute-docs

tatiana commented Jan 6, 2025

Uh oh!

codecov-commenter commented Jan 6, 2025 •

edited

Loading

Uh oh!

pankajkoti left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lzdanski left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tatiana commented Jan 6, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

tatiana commented Jan 6, 2025

Uh oh!

codecov-commenter commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pankajkoti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lzdanski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tatiana commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Jan 6, 2025 •

edited

Loading

tatiana commented Jan 6, 2025 •

edited

Loading