[ 
https://issues.apache.org/jira/browse/AIRFLOW-6556?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17016838#comment-17016838
 ] 

Kamil Bregula commented on AIRFLOW-6556:
----------------------------------------

I would be happy if they were added to the documentation:

*Webserver*:
 * General information e.g. why do we need him? 
 * How to configure webserver? We have a lot of options that are not described. 
 * Various information is also spread over several pages and I think it is 
worth collecting them in a commonplace

*Scheduler*:
 * General information e.g. why do we need him? 
 * How to configure scheduler? We have a lot of options that are not described. 
A lot of information is on the "Concept" page and should be on a separate 
subpage.

*Logging*:

We have documentation about writing, but we don't have documentation on how to 
use and how to configure reading.
We don't have descriptions on how to use it.

*Security*:

This page needs to be split because RBAC is only part of the UI interface and 
is confused with full isolation.

*SMTP*:

The configuration of the email configuration description should be on a 
separate page. This should not be on the "Concept" page. This is very confusing 
and introduces unnecessary information for end-users - not administrators.

*CeleryExecutor*:

Documentation describing the configuration is in the initial phase. I think 
it's worth expanding.

*Systemd/upstart:*

Page "Running Airflow with systemd" and page "Running Airflow with upstart" 
should be combined and contain a common introduction e.g.  the goals and 
differences between the two solutions.

*Using the Test Mode Configuration*

I think this page should be combined with the "Setting Configuration Options" 
page.

*Database*:

I think there is a lack of documentation that allows you to choose the right 
database and facilitates its configuration and use. The documentation only 
describes the `airflow db init` option. This should also include a description 
of the other `db` commands.

*Telemetry*:

I would be happy if the general information about telemetry has been added, 
which would contain references to following section:
 * Logs
 * Metrics  - Statsd
 * tracking error - Sentry
 * Tracking User Activity(Google Analytics etc)
 * Graph descriptions that are generated in Airflow UI. 

This should also describe the purposes and ways of using this data.

The statsd description should also show a simple description of use, e.g. using 
Stackdriver Metrics or Graphana.

 

 

 

 

> Improving unclear and incomplete documentation
> ----------------------------------------------
>
>                 Key: AIRFLOW-6556
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-6556
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: master
>            Reporter: Jacob Ward
>            Assignee: Jarek Potiuk
>            Priority: Trivial
>
> To help improve documentation it was discussed in the mailing list that users 
> of Airflow should have somewhere to report missing, incomplete or unclear 
> documentation. Any users who find this should comment on this ticket.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to