-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Closed
Labels
good first issuekind:documentationkind:metaHigh-level information important to the communityHigh-level information important to the community
Description
Body
Related to #9415, which updates the code example DAGs to use the TaskFlow API, the documentation throughout should also reflect the same functional style for overall documentation alignment as well as encourage users and bring more visibility to these TaskFlow decorators.
Currently there are 3 core TaskFlow decorators can be used instead of their "classic" operator counterparts.
| Classic Operator | TaskFlow Decorator |
|---|---|
PythonOperator |
@task |
PythonVirtualenvOperator |
@task.virtualenv |
BranchPythonOperator |
@task.branch |
There are a number of doc files that could be updated to the TaskFlow equivalents of the "classic" operators:
- docs/apache-airflow/best-practices.rst
- docs/apache-airflow/faq.rst
- docs/apache-airflow/index.rst
- docs/apache-airflow/tutorial.rst
- I'll be bold and say maybe there shouldn't be a "classic" tutorial and a TaskFlow API tutorial especially since the desire is to encourage TaskFlow and it's been 1.5 years since its release. Open to discuss this of course and what the community thinks here.
- docs/apache-airflow/concepts/dags.rst
- docs/apache-airflow/concepts/operators.rst
- docs/apache-airflow/concepts/params.rst
- docs/apache-airflow/howto/operator/python.rst
- This should be refactored to
_docs/apache-airflow/howto/decorators/python.rst. Add@task.short_circuitTaskFlow decorator #25752 is the last decorator implementation for Python operators. Once that is merged, we should refactor this page and fully sunset the operator doc.
- This should be refactored to
- docs/apache-airflow/upgrading-from-1-10/index.rst
Committer
- I acknowledge that I am a maintainer/committer of the Apache Airflow project.
Metadata
Metadata
Labels
good first issuekind:documentationkind:metaHigh-level information important to the communityHigh-level information important to the community