josh-fell opened a new issue, #25319:
URL: https://github.com/apache/airflow/issues/25319
### 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_
- Seems worthy to update these how-to guide as well since the underlying
example DAG snippets have been changed to use TaskFlow API. Any other thoughts
here?
- [ ] _docs/apache-airflow/upgrading-from-1-10/index.rst_
### Committer
- [X] I acknowledge that I am a maintainer/committer of the Apache Airflow
project.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
