mik-laj commented on issue #4898: [AIRFLOW-XXXX] how to setup simple test env with mysql URL: https://github.com/apache/airflow/pull/4898#issuecomment-475143470 @feng-tao Creating file in howto directory is the simplest solution. Each document can have any structure and does not have to be associated with others in any way. As a last resort, we should create a file in the howto directory if there is no other better place. The list of guides in no way allows you to create a documentation structure in any way. The documentation must be structured if it is to be user-friendly. I would like to limit the number of files in the howto directory, because it will not allow to create high-quality documentation in the long-term. Currently, work is underway to create a better place for information that the milton0825 user would like to add. Reference: https://github.com/apache/airflow/pull/4827 If this change is accepted, we will have one place that will support the developer. The documentation will be able to have a structure. In the future, further documents are planned, which will describe other information for the developer ex. Google Integration Guide https://lists.apache.org/thread.html/af7637c61acbb877dc68f337b633b2c34a43f91a2ebafc61208daf0c@%3Cdev.airflow.apache.org%3E We have only one environment described for now, but in the future we will have several environments described and work on the description is ongoing. One place for developer information is needed. Reference: https://github.com/apache/airflow/pull/4932/files I point out that the purpose of the documentation is to show how to do something, so the existence of this directory is not a good idea, but it is currently the shortest way to add a new element. This is a good temporary solution, but it should not be recommended. Summary: "howto" is a better solution, as a short term solution. It is a place that is much more developer-accessible, but this is a worse solution in a longer period of time. CC: @potiuk
---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
