mik-laj commented on a change in pull request #10970:
URL: https://github.com/apache/airflow/pull/10970#discussion_r492374406
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
+
+ For more information, see: :doc:`/howto/set-config`.
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}_CMD
+
+ For any specific key in a section in Airflow,
+ execute the command the key is pointing to.
+
+.. envvar:: AIRFLOW_CONFIG
+
+ The path to the Airflow configuration file.
+
+.. envvar:: AIRFLOW_CONN_{CONN_ID}
+
+ Defines a connection URI.
+ The user may replace the ``{CONN_ID}`` placeholder with the connection name.
+ For example, the user may create a connection named
"AIRFLOW_CONN_PROXY_POSTGRES_TCP"
+ to connect via proxy over TCP.
+
+ For more information, see: :ref:`environment_variables_secrets_backend`.
+
+.. envvar:: AIRFLOW_HOME
+
+ The root directory for the Airflow content.
+ This is the default parent directory for Airflow assets such as DAGs and
logs.
+
+.. envvar:: AIRFLOW_VAR_{KEY}
+
+ Defines an Airflow variable.
+ The user may replace the ``{KEY}`` placeholder with the variable name.
+
+ For more information, see: <link to Storing Variables in Environment
Variables on https://airflow.readthedocs.io/en/latest/howto/variable.html>.
Review comment:
Can you add use ref here? See:
https://stackoverflow.com/questions/15394347/adding-a-cross-reference-to-a-subheading-or-anchor-in-another-page
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
+
+ For more information, see: :doc:`/howto/set-config`.
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}_CMD
+
+ For any specific key in a section in Airflow,
+ execute the command the key is pointing to.
+
+.. envvar:: AIRFLOW_CONFIG
+
+ The path to the Airflow configuration file.
+
+.. envvar:: AIRFLOW_CONN_{CONN_ID}
+
+ Defines a connection URI.
+ The user may replace the ``{CONN_ID}`` placeholder with the connection name.
+ For example, the user may create a connection named
"AIRFLOW_CONN_PROXY_POSTGRES_TCP"
+ to connect via proxy over TCP.
+
+ For more information, see: :ref:`environment_variables_secrets_backend`.
+
+.. envvar:: AIRFLOW_HOME
+
+ The root directory for the Airflow content.
+ This is the default parent directory for Airflow assets such as DAGs and
logs.
+
+.. envvar:: AIRFLOW_VAR_{KEY}
+
+ Defines an Airflow variable.
+ The user may replace the ``{KEY}`` placeholder with the variable name.
Review comment:
```suggestion
You may replace the ``{KEY}`` placeholder with the variable name.
```
I think we should address the reader directly. Use you, instead of the user
or they.
See: https://developers.google.com/style/person
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
+
+ For more information, see: :doc:`/howto/set-config`.
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}_CMD
+
+ For any specific key in a section in Airflow,
+ execute the command the key is pointing to.
+
+.. envvar:: AIRFLOW_CONFIG
+
+ The path to the Airflow configuration file.
+
+.. envvar:: AIRFLOW_CONN_{CONN_ID}
+
+ Defines a connection URI.
+ The user may replace the ``{CONN_ID}`` placeholder with the connection name.
Review comment:
```suggestion
You may replace the ``{CONN_ID}`` placeholder with the connection name.
```
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
Review comment:
```suggestion
For example, If you want to set the ``dags_folder`` options in ``[core]``
section, then you
should set the ``AIRFLOW__CORE__DAGS_FOLDER`` environment variable.
```
There are a few problems here. First, not the best tone of speech. The word
may in context suggests that there is another variable name as well. Second,
all sentences should address the reader directly. Third, if you refer to a
section name it should always be written in square brackets as a code literal.
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
Review comment:
I hope you do not offend my comments, but I do try to make the
documentation accessible to a wide audience.
I believe that every developer should read Google's guide, which highlights
some good practices.
https://developers.google.com/style
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
Review comment:
This sentence does not explain what this option does.
> Sets options in the Airflow configuration. This takes priority over the
value in the ``airflow.cfg`` file.
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
Review comment:
This sentence does not explain what this option does. The noun
"configuration" is at least missing.
> Sets options in the Airflow configuration. This takes priority over the
value in the ``airflow.cfg`` file.
##########
File path: docs/cli-ref.rst
##########
@@ -35,3 +35,46 @@ development and testing.
:module: airflow.cli.cli_parser
:func: get_parser
:prog: airflow
+
+Environment Variables
+'''''''''''''''''''''
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}
+
+ Any specific key in a section in Airflow.
+ The user may replace the ``{SECTION}`` placeholder with any section
+ and the ``{KEY}`` placeholder with any key in that specified section.
+ For example, the user may initiate "AIRFLOW__CORE__DAGS_FOLDER",
+ where CORE is the section and DAGS_FOLDER is the key within the section.
+
+ For more information, see: :doc:`/howto/set-config`.
+
+.. envvar:: AIRFLOW__{SECTION}__{KEY}_CMD
+
+ For any specific key in a section in Airflow,
+ execute the command the key is pointing to.
+
+.. envvar:: AIRFLOW_CONFIG
+
+ The path to the Airflow configuration file.
+
+.. envvar:: AIRFLOW_CONN_{CONN_ID}
+
+ Defines a connection URI.
Review comment:
This does not define a connection URI, but a new connection using the
URI.
----------------------------------------------------------------
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]
