Much more docs improvments

XD-DENG · Feb 2, 2015 · 5da5b72 · 5da5b72
1 parent 02cc2f0
commit 5da5b72
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 4 deletions.
diff --git a/docs/img/adhoc.png b/docs/img/adhoc.png
diff --git a/docs/img/dags.png b/docs/img/dags.png
diff --git a/docs/img/gantt.png b/docs/img/gantt.png
diff --git a/docs/img/graph.png b/docs/img/graph.png
diff --git a/docs/img/tree.png b/docs/img/tree.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -69,7 +69,7 @@ Content
 
     installation
     ui
-    code
-    cli
-    profiling
     tutorial
+    profiling
+    cli
+    code
diff --git a/docs/profiling.rst b/docs/profiling.rst
@@ -13,3 +13,4 @@ The adhoc query UI allows for simple SQL interaction with the database
 connections registered in Airflow.
 
 .. image:: img/adhoc.png
+
diff --git a/docs/start_doc_server.sh b/docs/start_doc_server.sh
@@ -0,0 +1 @@
+python -m SimpleHTTPServer 8000
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -1,6 +1,6 @@
 
 Airflow tutorial
-=============
+================
 
 This tutorial walks through some of the fundamental concepts, objects
 and their usage.

diff --git a/docs/ui.rst b/docs/ui.rst
@@ -1,17 +1,91 @@
 UI / Screenshots
 =================
 The Airflow UI make it easy to monitor and troubleshoot your data pipelines.
+Here's a quick overview of some of the features and visualizations you
+can find in the Airflow UI.
+
+
+DAGs View
+.........
+List of the DAGs in your environment, and a set of shortcuts to useful pages.
+You can see exactly how many tasks succeeded, failed and are currently
+running at a glance.
+
+------------
+
+.. image:: img/dags.png
+
+------------
+
 
 Tree 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 at and identify
+the blocking ones.
+
+------------
 
 .. image:: img/tree.png
 
+------------
+
 Graph View
+..........
+The graph is perhaps the most comprehensive. Visualize your DAG's dependencies
+and their current status for a specific run.
+
+------------
 
 .. image:: img/graph.png
 
+------------
+
 Gantt Chart
+...........
+The Gantt chart lets you analyse task duration and overlap, you can quickly
+identify bottlenecks and where the bulk of the time is spent for specific
+DAG runs.
+
+------------
 
 .. image:: img/gantt.png
 
+------------
+
+Task Duration
+.............
+The duration of your different tasks over the past N runs. This view lets 
+you find outliers and quickly understand where the time is spent in your
+DAG, over many runs.
+
+
+------------
+
+.. image:: img/duration.png
+
+------------
+
+Code View
+.........
+Transparency is everything. While the code for your pipeline is in source
+control, this is a quick way to get to the code that generates the DAG and
+provide yet more context.
+
+------------
+
+.. image:: img/code.png
+
+------------
+
+Task Instance Context Menu
+.........
+From the pages seen above (tree view, graph view, gantt, ...), it is always
+possible to click on a task instance, and get to this rich context menu
+that can take you to more detailed metadata, and perform some actions.
+
+------------
+
+.. image:: img/context.png
 
+------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,3 +13,4 @@ The adhoc query UI allows for simple SQL interaction with the database
		connections registered in Airflow.

		.. image:: img/adhoc.png