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/10/19 11:05:20 UTC

[GitHub] [airflow] tiago-palma commented on a change in pull request #10852: Add prerequisite to add-dag-tags documentation

tiago-palma commented on a change in pull request #10852:
URL: https://github.com/apache/airflow/pull/10852#discussion_r507659849



##########
File path: docs/howto/add-dag-tags.rst
##########
@@ -0,0 +1,49 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+
+
+Add tags to DAGs and use it for filtering in the UI
+===================================================
+
+.. versionadded:: 1.10.8
+
+In order to filter DAGs (e.g by team), you can add tags in each dag.
+The filter is saved in a cookie and can be reset by the reset button.
+
+For example:
+
+In your Dag file, pass a list of tags you want to add to DAG object:
+
+.. code-block:: python
+
+  dag = DAG(
+    dag_id='example_dag_tag',
+    schedule_interval='0 0 * * *',
+    tags=['example']
+  )
+
+**Screenshot**:
+
+.. image:: ../img/add-dag-tags.png
+
+**UI Prerequisite**:
+
+The web UI with RBAC feature needs to be enabled; otherwise, the UI
+will not allow you to filter DAGs using tags nor show you the tag
+labels.

Review comment:
       The idea was to have this prerequisite section for the documentation >=1.10.8 and <2.0 for those who do not have the latest installed.
   For documentation >= 2.0, the prerequisite section can simply disappear?




----------------------------------------------------------------
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