From 05d2558f9fe8825fce6e107e4f3b08bcf16e9be1 Mon Sep 17 00:00:00 2001
From: "David B. Kinder" <david.b.kinder@intel.com>
Date: Fri, 29 Jun 2018 11:51:56 -0700
Subject: [PATCH] doc: move graphviz material to developer-guides

Rather than a "tutorial", it was suggested to move the graphviz
information to the devleoper-guides, along with the documentation
guidelines.  Makes sense.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
---
 doc/developer-guides/doc_guidelines.rst       | 39 +++++++++++++++++++
 .../graphviz.rst                              |  2 +-
 .../images/boot-flow.dot                      |  0
 .../images/circle-square.dot                  |  0
 .../images/gaspump.dot                        |  0
 .../images/node-shape-edges.dot               |  0
 .../images/record.dot                         |  0
 doc/developer-guides/index.rst                |  1 +
 8 files changed, 41 insertions(+), 1 deletion(-)
 rename doc/{tutorials => developer-guides}/graphviz.rst (99%)
 rename doc/{tutorials => developer-guides}/images/boot-flow.dot (100%)
 rename doc/{tutorials => developer-guides}/images/circle-square.dot (100%)
 rename doc/{tutorials => developer-guides}/images/gaspump.dot (100%)
 rename doc/{tutorials => developer-guides}/images/node-shape-edges.dot (100%)
 rename doc/{tutorials => developer-guides}/images/record.dot (100%)

diff --git a/doc/developer-guides/doc_guidelines.rst b/doc/developer-guides/doc_guidelines.rst
index 2766e9fb1..e3d8435a2 100644
--- a/doc/developer-guides/doc_guidelines.rst
+++ b/doc/developer-guides/doc_guidelines.rst
@@ -393,3 +393,42 @@ the first non-white space in the preceding line.  For example:
 Keep the line length for documentation less than 80 characters to make
 it easier for reviewing in GitHub. Long lines because of URL references
 are an allowed exception.
+
+Drawings
+********
+
+You can include a picture (.jpg, .png, .svg for example) by using the
+``.. image`` directive::
+
+   .. image:: ../images/ACRNlogo.png
+      :align: center
+
+This results in the image being placed in the document:
+
+.. image:: ../images/ACRNlogo.png
+   :align: center
+
+Alternatively, use the ``.. figure`` directive to include a picture with
+a caption and automatic figure numbering for
+your image, (so you can say see :numref:`acrn-logo-figure`, by using the
+notation ``:numref:`acrn-logo-figure``` and specifying the name of
+figure)::
+
+   .. figure:: ../images/ACRNlogo.png
+      :align: center
+      :name: acrn-logo-figure
+
+      Caption for the figure
+
+.. figure:: ../images/ACRNlogo.png
+   :align: center
+   :name: acrn-logo-figure
+
+   Caption for the figure
+
+
+We've also included the ``graphviz`` Sphinx extension to let you use a text
+description language to render drawings.  See :ref:`graphviz-examples` for more
+information.
+
+
diff --git a/doc/tutorials/graphviz.rst b/doc/developer-guides/graphviz.rst
similarity index 99%
rename from doc/tutorials/graphviz.rst
rename to doc/developer-guides/graphviz.rst
index fe516808d..0501e62dd 100644
--- a/doc/tutorials/graphviz.rst
+++ b/doc/developer-guides/graphviz.rst
@@ -1,4 +1,4 @@
-.. graphviz-examples:
+.. _graphviz-examples:
 
 Drawings using graphviz
 #######################
diff --git a/doc/tutorials/images/boot-flow.dot b/doc/developer-guides/images/boot-flow.dot
similarity index 100%
rename from doc/tutorials/images/boot-flow.dot
rename to doc/developer-guides/images/boot-flow.dot
diff --git a/doc/tutorials/images/circle-square.dot b/doc/developer-guides/images/circle-square.dot
similarity index 100%
rename from doc/tutorials/images/circle-square.dot
rename to doc/developer-guides/images/circle-square.dot
diff --git a/doc/tutorials/images/gaspump.dot b/doc/developer-guides/images/gaspump.dot
similarity index 100%
rename from doc/tutorials/images/gaspump.dot
rename to doc/developer-guides/images/gaspump.dot
diff --git a/doc/tutorials/images/node-shape-edges.dot b/doc/developer-guides/images/node-shape-edges.dot
similarity index 100%
rename from doc/tutorials/images/node-shape-edges.dot
rename to doc/developer-guides/images/node-shape-edges.dot
diff --git a/doc/tutorials/images/record.dot b/doc/developer-guides/images/record.dot
similarity index 100%
rename from doc/tutorials/images/record.dot
rename to doc/developer-guides/images/record.dot
diff --git a/doc/developer-guides/index.rst b/doc/developer-guides/index.rst
index 7da6f1b1c..e1ad2c29f 100644
--- a/doc/developer-guides/index.rst
+++ b/doc/developer-guides/index.rst
@@ -23,3 +23,4 @@ project.
 
    contribute_guidelines.rst
    doc_guidelines.rst
+   graphviz.rst