mik-laj edited a comment on issue #14231: URL: https://github.com/apache/airflow/issues/14231#issuecomment-779434031
For contributors, we already have a script, and of course if it has bugs we should fix it. In this ticket, I tried to focus on the documentation for end users, as I believe this is the biggest problem. See: https://github.com/apache/airflow/issues/13838 > Part of: #13838 > I think for users, this should be simply description in the places we already have - again, let's not reinvent the wheel: In my opinion, there are several types of documentation, each with its own audience and purpose. First of all, both guides you mentioned are intended for advanced users and they try to describe all the information **most accurately** and at the same time do not describe some steps if they fall outside the scope of this project, e.g. they do not describe the configuration of the Python interpreter because it assumes that every user has a Python interpreter (this is a trap because even if it has a good version, it can be badly compiled). "A quick start guide is a very simple guide with only the most important information that is required to get start with using the product or service. A User manual on the other hand needs to be much more comprehensive and cover all aspects of the product or service. It needs to take into account all the ways that a user might use your product and provide relevant help to complete the relevant tasks." (https://www.quora.com/What-are-the-important-functional-differences-between-a-Quick-Start-Guide-and-an-User-Manual-Guide) In my opinion, we lack documentation intended for **novice users** who are not experts in Python and system administration, but who just want to install Airflow and start experimenting with it. They don't need to make decisions about the type of database because they don't need that knowledge. They need a single database that's easy to install and reliable. You can think of this guide as a guide, which will be **directed to our close friend** - @mschickensoup. I have the impression that she doesn't need and doesn't even want to teach everything about installation Airflow for all operating systems. She knows that she has a **Mac OS computer** and that she has access to training materials from @Marc Lambert that teach her **how to code DAG files**. I have the impression that although she would like to learn everything, it is too laborious and I think she does not need it at all. She just wanted to learn how to use Airflow, not how to administer operating systems. For this reason, I would like to prepare a guide that will not describe all possible scenarios but describe only one step-by-step installation scenario. Do you think that we currently have a documentation guide that our friend Karolina Rosół could use to prepare the environment for learning how to write DAGs? Do you think that a similar guide would be worth contributing for her? ---------------------------------------------------------------- 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]
