This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new a7691b787b Simplify some docs around airflow_local_settings (#37835)
a7691b787b is described below
commit a7691b787b878121250b325aff5d8fa6cc18c8ab
Author: Jed Cunningham <[email protected]>
AuthorDate: Fri Mar 1 12:12:58 2024 -0700
Simplify some docs around airflow_local_settings (#37835)
This builds on what we did in #37829.
---
docs/apache-airflow/howto/customize-ui.rst | 26 ++++++++--------------
docs/apache-airflow/howto/export-more-env-vars.rst | 12 +---------
2 files changed, 10 insertions(+), 28 deletions(-)
diff --git a/docs/apache-airflow/howto/customize-ui.rst
b/docs/apache-airflow/howto/customize-ui.rst
index 46595e7210..600a58e2c2 100644
--- a/docs/apache-airflow/howto/customize-ui.rst
+++ b/docs/apache-airflow/howto/customize-ui.rst
@@ -28,15 +28,7 @@ Customizing state colours
To change the colors for TaskInstance/DagRun State in the Airflow Webserver,
perform the
following steps:
-1. Create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
- to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config``
on ``PYTHONPATH`` when
- Airflow is initialized)
-
-See :ref:`Configuring local settings <set-config:configuring-local-settings>`
for details on how to
-configure local settings.
-
-
-2. Add the following contents to ``airflow_local_settings.py`` file. Change
the colors to whatever you
+1. Add the following contents to ``airflow_local_settings.py`` file. Change
the colors to whatever you
would like.
.. code-block:: python
@@ -56,9 +48,10 @@ configure local settings.
"upstream_failed": "orange",
}
+ See :ref:`Configuring local settings
<set-config:configuring-local-settings>` for details on how to
+ configure local settings.
-
-3. Restart Airflow Webserver.
+2. Restart Airflow Webserver.
Screenshots
^^^^^^^^^^^
@@ -140,11 +133,7 @@ Add custom alert messages on the dashboard
Extra alert messages can be shown on the UI dashboard. This can be useful for
warning about setup issues
or announcing changes to end users. The following example shows how to add a
simple alert message:
-1. Create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
- to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config``
on ``PYTHONPATH`` when
- Airflow is initialized)
-
-2. Add the following contents to ``airflow_local_settings.py`` file.
+1. Add the following contents to ``airflow_local_settings.py`` file.
.. code-block:: python
@@ -154,7 +143,10 @@ or announcing changes to end users. The following example
shows how to add a sim
UIAlert("Welcome to Airflow"),
]
-3. Restart Airflow Webserver, and you should now see:
+ See :ref:`Configuring local settings
<set-config:configuring-local-settings>` for details on how to
+ configure local settings.
+
+2. Restart Airflow Webserver, and you should now see:
.. image:: ../img/ui-alert-message.png
diff --git a/docs/apache-airflow/howto/export-more-env-vars.rst
b/docs/apache-airflow/howto/export-more-env-vars.rst
index 84c269d056..e393f47930 100644
--- a/docs/apache-airflow/howto/export-more-env-vars.rst
+++ b/docs/apache-airflow/howto/export-more-env-vars.rst
@@ -30,17 +30,7 @@ value are must be string.
``dag_id``, ``task_id``, ``execution_date``, ``dag_run_id``,
``dag_owner``, ``dag_email`` are reserved keys.
-
-1. Create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
- to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config``
on ``PYTHONPATH`` when
- Airflow is initialized)
-
-2. Define ``get_airflow_context_vars`` in ``airflow_local_settings.py`` file.
-
-
-For example:
-
-In your ``airflow_local_settings.py`` file.
+For example, in your ``airflow_local_settings.py`` file:
.. code-block:: python
