Tim Swast created AIRFLOW-2509:
----------------------------------
Summary: Separate Configuration page into separate how-to guides
Key: AIRFLOW-2509
URL: https://issues.apache.org/jira/browse/AIRFLOW-2509
Project: Apache Airflow
Issue Type: Improvement
Components: Documentation
Reporter: Tim Swast
The existing "Configuration" page is attempting to be both a tutorial (teaching
the basics of Airflow configuration & a minimal production deployment) as well
as how-tos for specific tasks.
I propose we separate Configuration into separate how-to guides, keeping the
current sequence so that it can still maintain the tutorial properties (at
least until a "Deploying a Production Airflow Environment" tutorial is written).
There's a principle that the [distinct kinds of
documentation|http://www.writethedocs.org/videos/eu/2017/the-four-kinds-of-documentation-and-why-you-need-to-understand-what-they-are-daniele-procida/]
should be organized separately. The Django project does this
[https://docs.djangoproject.com/en/2.0/] by splitting into
* Tutorials
* Topic guides (what Airflow calls Concepts)
* Reference guides
* How-to guides
I think the same could apply well here. (This issue covers only How-to for
Configuration. More work would be required to separate other docs into proper
document types.)
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
