Skip to content

docs: Improve AIRFLOW_ASYNCdocs#2103

Merged
tatiana merged 24 commits into
mainfrom
improve-async-docs
Nov 11, 2025
Merged

docs: Improve AIRFLOW_ASYNCdocs#2103
tatiana merged 24 commits into
mainfrom
improve-async-docs

Conversation

@tatiana
Copy link
Copy Markdown
Collaborator

@tatiana tatiana commented Nov 10, 2025

Further improve the ExecutionMode.AIRFLOW_ASYNCdocumentation by:

  • Encourage high performance configuration by default
  • Avoid information duplication

- Encourage high performance configuration by default
- Avoid information duplication
@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 10, 2025

Deploy Preview for sunny-pastelito-5ecb04 ready!

Name Link
🔨 Latest commit 669861e
🔍 Latest deploy log https://app.netlify.com/projects/sunny-pastelito-5ecb04/deploys/69134b81003eda00085f9e28
😎 Deploy Preview https://deploy-preview-2103--sunny-pastelito-5ecb04.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@tatiana tatiana marked this pull request as ready for review November 10, 2025 12:44
Copilot AI review requested due to automatic review settings November 10, 2025 12:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the documentation for Cosmos's ExecutionMode.AIRFLOW_ASYNC mode by encouraging high-performance defaults and eliminating duplicate information. The changes update execution mode comparison tables, restructure documentation to highlight performance benefits, and move detailed implementation information to a dedicated async execution mode guide.

Key changes:

  • Updated performance metrics in comparison tables to reflect "Very Fast" for async modes
  • Added performance benchmarks showing 35% improvement over local execution
  • Reorganized content to reduce duplication between overview and detailed guide

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/getting_started/execution-modes.rst Updated comparison table, streamlined async mode overview by removing duplicated implementation details
docs/getting_started/async-execution-mode.rst Enhanced guide with performance benchmarks, restructured advantages section, added clearer limitations, and included optimal configuration guidance

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Copy link
Copy Markdown
Contributor

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

Looks good. Have some questions/suggestions inline if you'd like to consider.

Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread docs/getting_started/async-execution-mode.rst Outdated
tatiana and others added 3 commits November 10, 2025 13:10
Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
Comment thread docs/getting_started/async-execution-mode.rst Outdated
@tatiana tatiana merged commit 80f1678 into main Nov 11, 2025
82 checks passed
@tatiana tatiana deleted the improve-async-docs branch November 11, 2025 14:57
tatiana added a commit that referenced this pull request Nov 12, 2025
Further improve the `ExecutionMode.AIRFLOW_ASYNC`documentation by:
 - Encourage high performance configuration by default
- Avoid information duplication

(cherry picked from commit 80f1678)
@tatiana tatiana mentioned this pull request Nov 12, 2025
tatiana added a commit that referenced this pull request Nov 12, 2025
Bug fixes

* Fix ``ExecutionMode.WATCHER`` deadlock in Airflow 3.0 & 3.1 by
@tatiana in #2087
* Fix ``ExecutionMode.AIRFLOW_ASYNC`` ``TaskGroup`` XCom issue by
@tatiana in #2088
* Guard watcher callback exceptions to avoid hanging producer tasks by
@pankajkoti in #2101
* Fix SQL templated field rendering for dynamically mapped tasks in
Airflow 2 by @tatiana in #2119

Enhancements

* Remove usage of contextmanager in plugins for accessing connections in
Airflow >= 3.1.2 by @pankajkoti in #2073

Docs

* Improve ``ExecutionMode.AIRFLOW_ASYNC`` docs by @tatiana in #2103
* Add note about experimenting threads count for the Watcher Execution
mode by @pankajkoti in #2083
* Fix minor documentation formatting issue by @dnskrv in #2098
* Correct example YAML key from ``operator_args`` to ``operator_kwargs``
by @jx2lee in #2091

Others

* Fix broken CI due to fastapi incompatibility with cadwyn for Airflow 3
by @pankajkoti in #2076
* pre-commit autoupdate in #2078, #2104

related:
astronomer/oss-integrations-private#272
@tatiana tatiana mentioned this pull request Nov 12, 2025
tatiana added a commit that referenced this pull request Nov 13, 2025
Bug fixes

* Fix ``ExecutionMode.WATCHER`` deadlock in Airflow 3.0 & 3.1 by
@tatiana in #2087
* Fix ``ExecutionMode.AIRFLOW_ASYNC`` ``TaskGroup`` XCom issue by
@tatiana in #2088
* Guard watcher callback exceptions to avoid hanging producer tasks by
@pankajkoti in #2101
* Fix SQL templated field rendering for dynamically mapped tasks in
Airflow 2 by @tatiana in #2119

Enhancements

* Remove usage of contextmanager in plugins for accessing connections in
Airflow >= 3.1.2 by @pankajkoti in #2073

Docs

* Improve ``ExecutionMode.AIRFLOW_ASYNC`` docs by @tatiana in #2103
* Add note about experimenting threads count for the Watcher Execution
mode by @pankajkoti in #2083
* Fix minor documentation formatting issue by @dnskrv in #2098
* Correct example YAML key from ``operator_args`` to ``operator_kwargs``
by @jx2lee in #2091

Others

* Fix broken CI due to fastapi incompatibility with cadwyn for Airflow 3
by @pankajkoti in #2076
* pre-commit autoupdate in #2078, #2104

Closes: astronomer/oss-integrations-private#272
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.

3 participants