From 93d6f69f70a0196526fccce69f0c203d4d99e36b Mon Sep 17 00:00:00 2001
From: dparalen <vetrisko@gmail.com>
Date: Tue, 4 Jul 2017 17:31:14 +0200
Subject: [PATCH] Introducing the installation content

Moving the installation and upgrade guides down the mandatory directory
structure.  Had to change the upgrade headline level.

Partial-Bug: 1702142

Change-Id: If00d2e3d90ac89421c51d1b1530d7cc685fad78f
---
 doc/source/admin/index.rst                    | 10 ++++++++++
 doc/source/{ => admin}/upgrade.rst            |  5 ++---
 doc/source/index.rst                          |  8 ++++----
 doc/source/{install.rst => install/index.rst} | 20 +++++++++----------
 4 files changed, 25 insertions(+), 18 deletions(-)
 create mode 100644 doc/source/admin/index.rst
 rename doc/source/{ => admin}/upgrade.rst (86%)
 rename doc/source/{install.rst => install/index.rst} (98%)

diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
new file mode 100644
index 000000000..4cd8458f4
--- /dev/null
+++ b/doc/source/admin/index.rst
@@ -0,0 +1,10 @@
+Administrator Guide
+===================
+
+How to upgrade Ironic Inspector
+-------------------------------
+
+.. toctree::
+  :maxdepth: 2
+
+  upgrade
diff --git a/doc/source/upgrade.rst b/doc/source/admin/upgrade.rst
similarity index 86%
rename from doc/source/upgrade.rst
rename to doc/source/admin/upgrade.rst
index 549aed214..8bdba7c1a 100644
--- a/doc/source/upgrade.rst
+++ b/doc/source/admin/upgrade.rst
@@ -1,6 +1,5 @@
-==============================================
-Bare Metal Introspection Service Upgrade Guide
-==============================================
+Upgrade Guide
+-------------
 
 The `release notes <http://docs.openstack.org/releasenotes/ironic-inspector/>`_
 should always be read carefully when upgrading the ironic-inspector service.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e03c3350d..b2a84e6be 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,14 +11,14 @@ User Guide
   HTTP API <http-api>
   Troubleshooting <troubleshooting>
 
-Admin Guide
-===========
+Install
+=======
 
 .. toctree::
   :maxdepth: 2
 
-  Installation <install>
-  Upgrade <upgrade>
+  install/index
+  admin/index
 
 Contributor
 ===========
diff --git a/doc/source/install.rst b/doc/source/install/index.rst
similarity index 98%
rename from doc/source/install.rst
rename to doc/source/install/index.rst
index 992348ea5..2aeca2013 100644
--- a/doc/source/install.rst
+++ b/doc/source/install/index.rst
@@ -1,7 +1,5 @@
-.. _install_guide:
-
-Installation
-------------
+Install Guide
+=============
 
 Install from PyPI_ (you may want to use virtualenv to isolate your
 environment)::
@@ -29,7 +27,7 @@ if you plan on installing **ironic-inspector** manually.
     **ironic-inspector** on Ubuntu.
 
 Version Support Matrix
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
 
 **ironic-inspector** currently requires the Bare Metal API version
 ``1.11`` to be provided by **ironic**. This version is available starting
@@ -58,7 +56,7 @@ Ocata+         5.0 - 5.X    5.0 - 5.X
     ironic version. This does not imply that it will be supported forever.
 
 Configuration
-~~~~~~~~~~~~~
+-------------
 
 Copy ``example.conf`` to some permanent place
 (e.g. ``/etc/ironic-inspector/inspector.conf``).
@@ -159,7 +157,7 @@ Replace ``stack`` with whatever user you'll be using to run
 **ironic-inspector**.
 
 Configuring IPA
-^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~
 
 ironic-python-agent_ is a ramdisk developed for **ironic** and support
 for **ironic-inspector** was added during the Liberty cycle. This is the
@@ -194,7 +192,7 @@ the `other builders
 .. _ironic-python-agent: https://docs.openstack.org/developer/ironic-python-agent/
 
 Configuring PXE
-^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~
 
 For the PXE boot environment, you'll need:
 
@@ -255,7 +253,7 @@ For the PXE boot environment, you'll need:
     several nodes.
 
 Configuring iPXE
-^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~
 
 iPXE allows better scaling as it primarily uses the HTTP protocol instead of
 slow and unreliable TFTP. You still need a TFTP server as a fallback for
@@ -315,7 +313,7 @@ nodes not supporting iPXE. To use iPXE, you'll need:
   ``undionly.kpxe``.
 
 Managing the **ironic-inspector** Database
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------
 
 **ironic-inspector** provides a command line client for managing its
 database. This client can be used for upgrading, and downgrading the database
@@ -352,7 +350,7 @@ Other available commands can be discovered by running::
     ironic-inspector-dbsync --help
 
 Running
-~~~~~~~
+-------
 
 ::