[airflow] branch main updated: Update tree doc references to grid (#22966)

bbovenzi Wed, 13 Apr 2022 07:20:45 -0700

This is an automated email from the ASF dual-hosted git repository.

bbovenzi 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 7fe97fb86f Update tree doc references to grid (#22966)
7fe97fb86f is described below

commit 7fe97fb86ffbf51db2d54e9a1b46520f5591579a
Author: Brent Bovenzi <[email protected]>
AuthorDate: Wed Apr 13 09:20:27 2022 -0500

    Update tree doc references to grid (#22966)
    
    * Update tree doc references to grid
    
    * Update docs/apache-airflow/ui.rst
    
    Co-authored-by: Jed Cunningham 
<[email protected]>
    
    * Update docs/apache-airflow/ui.rst
    
    Co-authored-by: Jed Cunningham 
<[email protected]>
    
    * revert Chart changes. move main grid view
    
    * Update docs/apache-airflow/ui.rst
    
    Co-authored-by: Tzu-ping Chung <[email protected]>
    
    Co-authored-by: Jed Cunningham 
<[email protected]>
    Co-authored-by: Tzu-ping Chung <[email protected]>
---
 README.md                                          |   4 +--
 .../dingding/example_dags/example_dingding.py      |   4 +--
 docs/apache-airflow/img/grid.png                   | Bin 0 -> 347155 bytes
 docs/apache-airflow/img/grid_instance_details.png  | Bin 0 -> 287820 bytes
 docs/apache-airflow/img/grid_mapped_task.png       | Bin 0 -> 334409 bytes
 docs/apache-airflow/img/grid_run_details.png       | Bin 0 -> 243661 bytes
 docs/apache-airflow/img/grid_task_group.png        | Bin 0 -> 56287 bytes
 .../img/task_manual_vs_scheduled.png               | Bin 5806 -> 5686 bytes
 docs/apache-airflow/img/tree.png                   | Bin 139707 -> 0 bytes
 docs/apache-airflow/ui.rst                         |  33 +++++++++++++++------
 tests/providers/dingding/hooks/test_dingding.py    |   4 +--
 11 files changed, 30 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 9993dae17e..b8f84fa583 100644
--- a/README.md
+++ b/README.md
@@ -215,9 +215,9 @@ following the ASF Policy.
 
   
![DAGs](https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/dags.png)
 
-- **Tree**: Tree representation of a DAG that spans across time.
+- **Grid**: Grid representation of a DAG that spans across time.
 
-  
![Tree](https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/tree.png)
+  
![Grid](https://raw.githubusercontent.com/apache/airflow/main/docs/apache-airflow/img/grid.png)
 
 - **Graph**: Visualization of a DAG's dependencies and their current status 
for a specific run.
 
diff --git a/airflow/providers/dingding/example_dags/example_dingding.py 
b/airflow/providers/dingding/example_dags/example_dingding.py
index ae60aa829c..7740d157ce 100644
--- a/airflow/providers/dingding/example_dags/example_dingding.py
+++ b/airflow/providers/dingding/example_dags/example_dingding.py
@@ -168,9 +168,9 @@ with DAG(
                     "picURL": "https://airflow.apache.org/_images/dags.png";,
                 },
                 {
-                    "title": "Airflow tree feed card",
+                    "title": "Airflow grid feed card",
                     "messageURL": 
"https://airflow.apache.org/docs/apache-airflow/stable/ui.html";,
-                    "picURL": "https://airflow.apache.org/_images/tree.png";,
+                    "picURL": "https://airflow.apache.org/_images/grid.png";,
                 },
                 {
                     "title": "Airflow graph feed card",
diff --git a/docs/apache-airflow/img/grid.png b/docs/apache-airflow/img/grid.png
new file mode 100644
index 0000000000..c3d50809cd
Binary files /dev/null and b/docs/apache-airflow/img/grid.png differ
diff --git a/docs/apache-airflow/img/grid_instance_details.png 
b/docs/apache-airflow/img/grid_instance_details.png
new file mode 100644
index 0000000000..65328508f0
Binary files /dev/null and b/docs/apache-airflow/img/grid_instance_details.png 
differ
diff --git a/docs/apache-airflow/img/grid_mapped_task.png 
b/docs/apache-airflow/img/grid_mapped_task.png
new file mode 100644
index 0000000000..dfd303e217
Binary files /dev/null and b/docs/apache-airflow/img/grid_mapped_task.png differ
diff --git a/docs/apache-airflow/img/grid_run_details.png 
b/docs/apache-airflow/img/grid_run_details.png
new file mode 100644
index 0000000000..fdb13387b4
Binary files /dev/null and b/docs/apache-airflow/img/grid_run_details.png differ
diff --git a/docs/apache-airflow/img/grid_task_group.png 
b/docs/apache-airflow/img/grid_task_group.png
new file mode 100644
index 0000000000..b69656582f
Binary files /dev/null and b/docs/apache-airflow/img/grid_task_group.png differ
diff --git a/docs/apache-airflow/img/task_manual_vs_scheduled.png 
b/docs/apache-airflow/img/task_manual_vs_scheduled.png
index d01b39fd84..ea7462f02f 100644
Binary files a/docs/apache-airflow/img/task_manual_vs_scheduled.png and 
b/docs/apache-airflow/img/task_manual_vs_scheduled.png differ
diff --git a/docs/apache-airflow/img/tree.png b/docs/apache-airflow/img/tree.png
deleted file mode 100644
index 42681b7953..0000000000
Binary files a/docs/apache-airflow/img/tree.png and /dev/null differ
diff --git a/docs/apache-airflow/ui.rst b/docs/apache-airflow/ui.rst
index 9ed53ff63c..1889f6883f 100644
--- a/docs/apache-airflow/ui.rst
+++ b/docs/apache-airflow/ui.rst
@@ -46,24 +46,39 @@ For example:
 ------------
 
 
-Tree View
+Grid View
 .........
-A tree representation of the DAG that spans across time. If a pipeline is
-late, you can quickly see where the different steps are and identify
+A bar chart and grid representation of the DAG that spans across time.
+The top row is a chart of DAG Runs by duration,
+and below, task instances. If a pipeline is late,
+you can quickly see where the different steps are and identify
 the blocking ones.
 
-There is also visual difference between scheduled and manually triggered
-DAGs/tasks:
+------------
+
+.. image:: img/grid.png
+
+------------
+
+The details panel will update when selecting a DAG Run by clicking on a 
duration bar:
+
+.. image:: img/grid_run_details.png
+
+Or selecting a Task Instance by clicking on a status box:
+
+.. image:: img/grid_instance_details.png
+
+Manual runs are indicated by a play icon (just like the Trigger DAG button):
 
 .. image:: img/task_manual_vs_scheduled.png
 
-The DAGs/tasks with a black border are scheduled runs, whereas the non-bordered
-DAGs/tasks are manually triggered, i.e. by ``airflow dags trigger``.
+Task groups are indicated by a caret and can be opened or closed:
 
+.. image:: img/grid_task_group.png
 
-------------
+Mapped Tasks are indicated by a square brackets and will show a table of each 
mapped task instance in the details panel:
 
-.. image:: img/tree.png
+.. image:: img/grid_mapped_task.png
 
 ------------
 
diff --git a/tests/providers/dingding/hooks/test_dingding.py 
b/tests/providers/dingding/hooks/test_dingding.py
index f033b33a1c..bf3e1ec5a9 100644
--- a/tests/providers/dingding/hooks/test_dingding.py
+++ b/tests/providers/dingding/hooks/test_dingding.py
@@ -191,9 +191,9 @@ class TestDingdingHook(unittest.TestCase):
                     "picURL": "https://airflow.apache.org/_images/dags.png";,
                 },
                 {
-                    "title": "Airflow tree feed card",
+                    "title": "Airflow grid feed card",
                     "messageURL": 
"https://airflow.apache.org/docs/apache-airflow/stable/ui.html";,
-                    "picURL": "https://airflow.apache.org/_images/tree.png";,
+                    "picURL": "https://airflow.apache.org/_images/grid.png";,
                 },
                 {
                     "title": "Airflow graph feed card",

[airflow] branch main updated: Update tree doc references to grid (#22966)

Reply via email to