mik-laj edited a comment on issue #14231: URL: https://github.com/apache/airflow/issues/14231#issuecomment-779587858
@potiuk instaallattion.rst is a user manual document that describes all possible installation scenarios. It is a very complex document and does not contain information on the configuration of other components, e.g. a database. This document also does not describe a step-by-step installation, but requires the user to decide which steps to follow eg you first need to install the database in order to install Airflow. Let's just look at what is included in the various sections of this page. * **Prerequisites**: this section uses the words "Kubernetes", "MySQL", "PostgreSQL", but for a novice user it is a buzzword and saying nothing and not able to decide whether he needs Kubernetes, MySQL or PostgresSQL. The novice user expects that this decision will be made by him and he will be told "Install PostgreSQL", but if he wishes he will have a link to detailed documentation that will allow him to change this selection. * **Installation tools:**: A novice user does not need information on custom installation tools. They even don't know these tools, so reading this section is a waste of time. However, he does not see this section, he may think that we expect him to make some decisions and perform steps that he can use these tools. When he sees this section, he may think that we expect him to make some decisions and perform steps that he can use these tools. * **Airflow extra dependencies:** This section describes the installation of additional components that are not needed for the first use. * **Provider packages:** This section describes the installation of additional components that are not needed for the first use. * **Differences between extras and providers:**: This section describes the installation of additional components that are not needed for the first use. * **System dependencies:**: This describes only one operating system and here we should add information about other operating systems and indicate which dependencies are not needed for the minimal installation. This section is not useful for the user because it contains too much information. For example: it contains information about Kerberos installation and ODBC drivers. But this is not useful knowledge for the novice user. Instead of 6 paragraphs of text (for now, we have 2 paragraphs, but that should be extended), we can only show the user one paragraph of text and add a link to this section to be able to read more detailed information. * **Constraints files**: This section provides information on floating pointers, several Airflow versions, and much more. The novice user needs a brief information that best suits his situation. * **Installation script:**: In this section, the user also has to make decisions, but the novice user does not have enough knowledge to do so. * **Python versions support:**: This section is not useful for Karolina Rosół when she wants to install Airflow for the first time. Additionally, it contains complex words that she will have problems with understanding, eg `EOL`, `smoke tests`, `PRs`, `CI Pipeline`, `non-patch version`. * **Set up a database:**: Database installation is another complex process that can also be facilitated by the user if we, as experts, make several decisions, e.g. database type, executor type, or if we know the audience (operating system) and prepare the content especially for him. Why is a quick start guide important? A quick start guide is a document that gives a user an overall understanding of the product in a short time span (5 to 10 minutes). On the other hand, we have a user manual that covers many installation scenarios and of course, if you have the skills and time you can install with this application documentation, but it won't be easy. Quick start does not replace the User Manual in any way, but is a summary of it. Any information that is in the Quick Start Guide should also be found in the User manual, but not all information in the User Manual is needed for a beginner. ---------------------------------------------------------------- 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]
