Skip to content

Create Task SDK docs #51283

Closed
Closed

Description

@sunank200

Description

The Task SDK currently has no dedicated documentation within the Airflow docs site or anywhere. We need to create a new site for “Task SDK” that covers installation, decorators, core classes (BaseOperator, Sensor, XComArg, etc.), definitions (assets, types), execution-time components (Supervisor, TaskRunner, Context), I/O helpers, and the API client.

Use case/motivation

  • Users installing apache-airflow-task-sdk need a clear “Getting Started” guide.
  • Developers need reference pages for decorators (@task, @dag, etc.) and core classes.
  • Runtime engineers need documentation on Supervisor/TaskRunner/Context for debugging and extension.
  • Without docs, adoption of the standalone Task SDK is hampered and contributions become more error-prone.

Related issues

  • AIP-72: Task Execution Interface (Task SDK) design proposal.
  • No existing GitHub issue explicitly tracking Task SDK docs creation.

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Activity

  1. removed
    needs-triagelabel for new issues that we didn't triage yet
    on Jun 2, 2025
  2. self-assigned this
    on Jun 9, 2025
  3. added a commit that references this issue on Jun 11, 2025
    ebfc0de
  4. added a commit that references this issue on Jul 2, 2025
    0cc4bfe
  5. added a commit that references this issue on Jul 2, 2025
    9afb410
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions