Skip to content

Add incipient documentation tooling#328

Merged
tatiana merged 1 commit into
mainfrom
docs-tooling
Jan 2, 2025
Merged

Add incipient documentation tooling#328
tatiana merged 1 commit into
mainfrom
docs-tooling

Conversation

@tatiana

@tatiana tatiana commented Jan 2, 2025

Copy link
Copy Markdown
Collaborator

This PR introduces an incipient version for documentation tooling in DAG Factory.

It introduces three requirements to create/generate documentation:

  • Mkdocs (tool recommended by the Astronomer docs team)
  • Mike (for documentation versioning)
  • pymdown-extensions (so we can leverage Snippets for injecting code from other files inline in the Markdown files)

Also, it introduces three new hatch commands:

  • hatch run docs:build: builds the docs locally, generating the correspondent static HTML website;
  • hatch run docs:serve: builds and serves the docs locally at localhost:8080;
  • hatch run docs:release: creates a version release using the version specified in dagfactory/__init__.py using Mike

This screenshot illustrates versioning:
Screenshot 2025-01-02 at 10 11 18

This screenshot illustrates code snippets:
Screenshot 2025-01-02 at 10 11 40

- Install Mkdocs
- Install Mike (for documetation versioning)
- Install pymdown-extensions (so we can leverage Snippets, for injecting code from other files inline in the Markdown files)

Also introduce three hash commands:
- hatch run docs:build
- hatch run docs:serve
- hatch run docs:release

The first builds the docs locally, the second serves them at localhost:8080 and the last creates a version release using Mike and sets it as the latest.
@tatiana tatiana requested a review from a team as a code owner January 2, 2025 10:15
@codecov-commenter

codecov-commenter commented Jan 2, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.29%. Comparing base (c171166) to head (db38d53).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #328   +/-   ##
=======================================
  Coverage   93.29%   93.29%           
=======================================
  Files          10       10           
  Lines         776      776           
=======================================
  Hits          724      724           
  Misses         52       52           

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

@tatiana tatiana mentioned this pull request Jan 2, 2025
@tatiana tatiana requested review from a team, pankajastro and pankajkoti January 2, 2025 11:10
@tatiana tatiana merged commit a53c765 into main Jan 2, 2025
@tatiana tatiana deleted the docs-tooling branch January 2, 2025 11:34
@tatiana tatiana added this to the DAG Factory 0.22.0 milestone Jan 2, 2025
Comment thread pyproject.toml
]

[tool.hatch.envs.docs.scripts]
build = "mike deploy --push dev"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

We just realised that this is publishing to GH pages 🙈
We'll fix this as part of #279

tatiana added a commit that referenced this pull request Jan 3, 2025
Add documentation illustrating how two Airflow Python DAGs (one using
traditional operators, another using TaskFlow API) are represented in
Python (standard Airflow) and YAML (DAG Factory).

We use real-world data: one DAG uses Hacker News, and the other uses
PyPI stats.

Before we merge this PR, I think we should merge #328 first and rebase
this one. I isolated the tooling changes (mkdocs and others) in PR #328.

Close: #319
@pankajkoti pankajkoti mentioned this pull request Jan 10, 2025
tatiana pushed a commit that referenced this pull request Jan 10, 2025
### 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants