You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/06/20 12:03:35 UTC
[GitHub] [airflow] mik-laj opened a new pull request #9438: Detect missing docs for config options
mik-laj opened a new pull request #9438:
URL: https://github.com/apache/airflow/pull/9438
Checks that each option name appears in the documentation.
A primitive check is done (``option_name in fie_content``), but it should be good enough to handle most cases
I believe that users do not write documentation because they do not know how to do it. A friendly message would definitely be helpful to them.
---
Make sure to mark the boxes below before creating PR: [x]
- [X] Description above provides context of the change
- [X] Unit tests coverage for changes (not needed for documentation changes)
- [X] Target Github ISSUE in description if exists
- [X] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [X] Relevant documentation is updated including usage instructions.
- [X] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
---
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443156216
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
+ "sql_alchemy_max_overflow",
+ "sql_alchemy_pool_enabled",
+ "sql_alchemy_pool_pre_ping",
+ "sql_alchemy_pool_recycle",
+ "sql_alchemy_pool_size",
+ "sql_alchemy_schema",
+ "sql_engine_collation_for_ids",
+ "sql_engine_encoding",
+ "statsd_datadog_enabled",
+ "statsd_datadog_tags",
+ "superuser_filter",
+ "sync_parallelism",
+ "task_log_prefix_template",
+ "task_log_reader",
+ "tls_ca",
+ "tls_cert",
+ "tls_key",
+ "use_job_schedule",
+ "user_filter",
+ "user_name_attr",
+ "visibility_timeout",
+ "web_server_host",
+ "web_server_master_timeout",
+ "web_server_worker_timeout",
+ "worker_annotations",
+ "worker_autoscale",
+ "worker_class",
+ "worker_container_image_pull_policy",
+ "worker_container_repository",
+ "worker_container_tag",
+ "worker_log_server_port",
+ "worker_pods_creation_batch_size",
+ "worker_precheck",
+ "worker_prefetch_multiplier",
+ "worker_refresh_batch_size",
+ "worker_refresh_interval",
+ "worker_resources",
+ "worker_service_account_name",
+}
+
+
+def check_config_options():
+ """
+ Checks that each option name appears in the documentation.
+
+ A primitive check is done (``option_name in fie_content``), but it should be good enough to
Review comment:
```suggestion
A primitive check is done (``option_name in file_content``), but it should be good enough to
```
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443127198
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
Review comment:
Oh yes, +1, I thought the script was still looking at the generated docs at configurations-ref, hence my comment
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443127067
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
Review comment:
I think we should also have documentation in /docs/directory. Reference documentation (/airflow/config_tempates/config.yaml file) is important, but it does not easily find this feature by new users. I would be happy if users would also add more detailed descriptions.
Here is an example of a good change.
https://github.com/apache/airflow/pull/9397/files
An option has been added to the reference catalog, but new documentation has also been added to the security.rst file.
It is also worth looking at how it is done by other projects. Kubernetes generates reference documentation.
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#ephemeralcontainer-v1-core
and also has normal documentation that is easier to understand and provides a broader description. On the other hand, it is less accurate in some places.
https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] ryw commented on pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
ryw commented on pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#issuecomment-717579873
@mik-laj anything blocking this?
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443127067
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
Review comment:
I think we should also have documentation in /docs/directory. Reference documentation (/airflow/config_tempates/config.yaml file) is important, but it does not easily find this feature by new users. I would be happy if users would also add more detailed descriptions.
Here is an example of a good change.
https://github.com/apache/airflow/pull/9397/files
An option has been added to the referenced docs, but new documentation has also been added to the security.rst file.
It is also worth looking at how it is done by other projects. Kubernetes generates reference documentation.
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#ephemeralcontainer-v1-core
and also has normal documentation that is easier to understand and provides a broader description. On the other hand, it is less accurate in some places.
https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] eladkal commented on pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
eladkal commented on pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#issuecomment-907129621
@mik-laj do we still need this PR?
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443126478
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
Review comment:
We already have docs: https://airflow.readthedocs.io/en/latest/configurations-ref.html#sql-alchemy-connect-args
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] mik-laj commented on a change in pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#discussion_r443127067
##########
File path: docs/build
##########
@@ -388,6 +390,232 @@ def check_gcp_guides():
build_errors.append(DocBuildError(file_path=__file__, line_no=None, message=message))
+OPTIONS_WITHOUT_DOCS = {
+ "access_logfile",
+ "airflow_configmap",
+ "airflow_local_settings_configmap",
+ "allow_illegal_arguments",
+ "api_rev",
+ "basedn",
+ "bind_user",
+ "ccache",
+ "celery_app_name",
+ "celery_config_options",
+ "child_process_log_directory",
+ "cluster_address",
+ "cluster_context",
+ "colored_console_log",
+ "colored_formatter_class",
+ "colored_log_format",
+ "cookie_samesite",
+ "cookie_secure",
+ "dag_cleanup_interval",
+ "dag_default_view",
+ "dag_dir_list_interval",
+ "dag_discovery_safe_mode",
+ "dag_file_processor_timeout",
+ "dag_orientation",
+ "dag_processor_manager_log_location",
+ "dagbag_import_timeout",
+ "dags_are_paused_at_creation",
+ "dags_in_image",
+ "dags_volume_claim",
+ "dags_volume_host",
+ "dags_volume_mount_point",
+ "dags_volume_subpath",
+ "data_profiler_filter",
+ "default_cpus",
+ "default_disk",
+ "default_email_on_failure",
+ "default_email_on_retry",
+ "default_gpus",
+ "default_hive_mapred_queue",
+ "default_owner",
+ "default_ram",
+ "default_task_retries",
+ "default_wrap",
+ "delete_option_kwargs",
+ "delete_worker_pods",
+ "delete_worker_pods_on_failure",
+ "demo_mode",
+ "donot_pickle",
+ "enable_xcom_pickling",
+ "env_from_configmap_ref",
+ "env_from_secret_ref",
+ "error_logfile",
+ "expose_config",
+ "expose_hostname",
+ "expose_stacktrace",
+ "fab_logging_level",
+ "flower_host",
+ "flower_port",
+ "force_log_out_after",
+ "frontend",
+ "fs_group",
+ "git_branch",
+ "git_dags_folder_mount_point",
+ "git_repo",
+ "git_ssh_key_secret_name",
+ "git_ssh_known_hosts_configmap_name",
+ "git_subpath",
+ "git_sync_container_repository",
+ "git_sync_container_tag",
+ "git_sync_credentials_secret",
+ "git_sync_depth",
+ "git_sync_dest",
+ "git_sync_init_container_name",
+ "git_sync_rev",
+ "git_sync_root",
+ "git_sync_run_as_user",
+ "git_user",
+ "group_member_attr",
+ "hide_paused_dags_by_default",
+ "hide_sensitive_variable_fields",
+ "hostname_callable",
+ "ignore_malformed_schema",
+ "image_pull_secrets",
+ "job_heartbeat_sec",
+ "killed_task_cleanup_time",
+ "kinit_path",
+ "kube_client_request_args",
+ "load_default_connections",
+ "load_examples",
+ "log_animation_speed",
+ "log_auto_tailing_offset",
+ "log_fetch_delay_sec",
+ "log_fetch_timeout_sec",
+ "log_filename_template",
+ "log_format",
+ "log_processor_filename_template",
+ "logging_level",
+ "logs_volume_claim",
+ "logs_volume_host",
+ "logs_volume_subpath",
+ "mapred_job_name_template",
+ "max_num_rendered_ti_fields_per_task",
+ "max_tis_per_query",
+ "min_file_process_interval",
+ "navbar_color",
+ "num_runs",
+ "operation_timeout",
+ "page_size",
+ "plugins_folder",
+ "pod_template_file",
+ "print_stats_interval",
+ "proxy_fix_x_port",
+ "proxy_fix_x_prefix",
+ "proxy_fix_x_proto",
+ "sasl_enabled",
+ "scheduler_zombie_task_threshold",
+ "search_scope",
+ "secret_key",
+ "session_lifetime_days",
+ "simple_log_format",
+ "smtp_host",
+ "smtp_mail_from",
+ "smtp_port",
+ "smtp_ssl",
+ "smtp_starttls",
+ "smtp_user",
+ "sql_alchemy_connect_args",
Review comment:
I think we should also have documentation in /docs/directory. Reference documentation (/airflow/config_tempates/config.yaml file) is important, but it does not easily find this feature by new users. I would be happy if users would also add more detailed descriptions.
Here is an example of a good change.
https://github.com/apache/airflow/pull/9397/files
An option has been added to the referenced docs, but new documentation has also been added to the security.rst file.
It is also worth looking at how it is done by other projects. Kubernetes generates reference documentation.
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#ephemeralcontainer-v1-core
and also has normal documentation that is easier to understand and provides a broader description. On the other hand, it is less accurate in some places.
https://kubernetes.io/docs/concepts/workloads/pods/ephemeral-containers/
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] stale[bot] commented on pull request #9438: Detect missing docs for config options
Posted by GitBox <gi...@apache.org>.
stale[bot] commented on pull request #9438:
URL: https://github.com/apache/airflow/pull/9438#issuecomment-670836651
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
----------------------------------------------------------------
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:
users@infra.apache.org