From: Akihiro Motoki <motoki@da.jp.nec.com>
Date: Wed, 23 Sep 2015 03:35:40 +0000 (+0900)
Subject: Fix the broken link in devref docs
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=63ed6aaecdfca33b44ac378860abddccea3ebd48;p=openstack-build%2Fneutron-build.git

Fix the broken link in devref docs

The link to Dashboard is broken in the generated docuemnt
http://docs.openstack.org/developer/neutron/
This patch fixes it and addresses warnings so that
tox -e docs works.

Also add a reference to Gerrit Dashboard Creator
so that developers can customize it to what they want.

Change-Id: Ic45ab48e68af9e5e8255161fe9eb2354ae124f50
---

diff --git a/doc/source/dashboards/check.dashboard.rst b/doc/source/dashboards/check.dashboard.rst
index 41364979d..71dd3ce12 100644
--- a/doc/source/dashboards/check.dashboard.rst
+++ b/doc/source/dashboards/check.dashboard.rst
@@ -1,6 +1,8 @@
 
-Neutron Check Pipeline Thumbnails - Click to see full size figure
-=================================================================
+Neutron Check Pipeline Thumbnails
+=================================
+
+Click to see full size figure.
 
 .. raw:: html
 
diff --git a/doc/source/dashboards/gate.dashboard.rst b/doc/source/dashboards/gate.dashboard.rst
index 206735acd..94fbbe9df 100644
--- a/doc/source/dashboards/gate.dashboard.rst
+++ b/doc/source/dashboards/gate.dashboard.rst
@@ -1,6 +1,8 @@
 
-Neutron Graphite Thumbnails - Click to see full size figure
-===========================================================
+Neutron Graphite Thumbnails
+===========================
+
+Click to see full size figure.
 
 .. raw:: html
 
diff --git a/doc/source/dashboards/index.rst b/doc/source/dashboards/index.rst
index bfef85742..85de81daf 100644
--- a/doc/source/dashboards/index.rst
+++ b/doc/source/dashboards/index.rst
@@ -5,11 +5,16 @@ Gerrit Dashboards
 - `Neutron subproject reviews (master branch) <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fdragonflow+OR+project%3Aopenstack%2Fnetworking%252Darista+OR+project%3Aopenstack%2Fnetworking%252Dbagpipe%252Dl2+OR+project%3Aopenstack%2Fnetworking%252Dbgpvpn+OR+project%3Aopenstack%2Fnetworking%252Dcisco+OR+project%3Aopenstack%2Fnetworking%252Dl2gw+OR+project%3Aopenstack%2Fnetworking%252Dlenovo+OR+project%3Aopenstack%2Fnetworking%252Dmidonet+OR+project%3Aopenstack%2Fnetworking%252Dodl+OR+project%3Aopenstack%2Fnetworking%252Dofagent+OR+project%3Aopenstack%2Fnetworking%252Donos+OR+project%3Aopenstack%2Fnetworking%252Dovn+OR+project%3Aopenstack%2Fnetworking%252Dsfc+OR+project%3Aopenstack%2Foctavia+OR+project%3Aopenstack%2Fnetworking%252Dplumgrid+OR+project%3Aopenstack%2Fvmware%252Dnsx+OR+project%3Aopenstack%2Fnetworking%252Dvsphere%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3Amaster&title=Neutron+Sub+Projects+Review+Inbox&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_
 - `Neutron stable branch reviews <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fneutron+OR+project%3Aopenstack%2Fpython%252Dneutronclient+OR+project%3Aopenstack%2Fneutron%252Dfwaas+OR+project%3Aopenstack%2Fneutron%252Dlbaas+OR+project%3Aopenstack%2Fneutron%252Dvpnaas+OR+project%3Aopenstack%2Fdragonflow+OR+project%3Aopenstack%2Fnetworking%252Darista+OR+project%3Aopenstack%2Fnetworking%252Dbagpipe%252Dl2+OR+project%3Aopenstack%2Fnetworking%252Dbgpvpn+OR+project%3Aopenstack%2Fnetworking%252Dcisco+OR+project%3Aopenstack%2Fnetworking%252Dl2gw+OR+project%3Aopenstack%2Fnetworking%252Dlenovo+OR+project%3Aopenstack%2Fnetworking%252Dmidonet+OR+project%3Aopenstack%2Fnetworking%252Dodl+OR+project%3Aopenstack%2Fnetworking%252Dofagent+OR+project%3Aopenstack%2Fnetworking%252Donos+OR+project%3Aopenstack%2Fnetworking%252Dovn+OR+project%3Aopenstack%2Fnetworking%252Dsfc+OR+project%3Aopenstack%2Foctavia+OR+project%3Aopenstack%2Fnetworking%252Dplumgrid+OR+project%3Aopenstack%2Fvmware%252Dnsx+OR+project%3Aopenstack%2Fnetworking%252Dvsphere%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3A%5Estable%2F.%2A&title=Neutron+Stable+Related+Projects+Review+Inbox&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dstable%252Dmaint+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dstable%252Dmaint+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_
 
+These dashboard links can be generated by `Gerrit Dashboard Creator`_.
+Useful dashboard definitions are found in ``dashboards`` directory.
+
+.. _Gerrit Dashboard Creator: https://github.com/stackforge/gerrit-dash-creator
+
 Neutron Graphite Pages
 ======================
 
-- `Graphs of gate job failures`_
-- `Graphs of check job failures`_
+.. toctree::
+   :maxdepth: 1
 
-.. _`Graphs of gate job failures`: gate.dashboard
-.. _`Graphs of check job failures`: check.dashboard
+   gate.dashboard
+   check.dashboard
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 84d3171fb..bed4d897f 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -58,13 +58,13 @@ Developer Docs
 Dashboards
 ==========
 
-.. toctree::
-   :maxdepth: 1
-
 There is a collection of dashboards to help developers and reviewers
-located here_
+located here.
+
+.. toctree::
+   :maxdepth: 2
 
-.. _here: dashboards/index
+   dashboards/index
 
 API Extensions
 ==============