From 1d281bb70c0df96cc4775b0e0011ad277b6d3c2f Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Mon, 3 Jul 2017 16:15:49 +0100
Subject: [PATCH] doc: Create directory structure for docs migration

The spec [1] recommends the following sections:

- install
- contributor
- configuration
- cli
- admin
- user
- reference

Only two of these are useful here:

- user
- reference

Add these and populate them.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: Ieab6ad5ef43a172743053a1cffc8d46deb235277
---
 doc/source/index.rst                          | 30 ++++++++++++-------
 doc/source/{ => reference}/glossary.rst       |  0
 .../{host_info.rst => user/host-info.rst}     |  0
 .../{ => user}/plugins/linux-bridge.rst       |  2 +-
 doc/source/{ => user}/plugins/ovs.rst         |  2 +-
 doc/source/{ => user}/usage.rst               |  0
 .../{vif_types.rst => user/vif-types.rst}     |  0
 7 files changed, 22 insertions(+), 12 deletions(-)
 rename doc/source/{ => reference}/glossary.rst (100%)
 rename doc/source/{host_info.rst => user/host-info.rst} (100%)
 rename doc/source/{ => user}/plugins/linux-bridge.rst (88%)
 rename doc/source/{ => user}/plugins/ovs.rst (96%)
 rename doc/source/{ => user}/usage.rst (100%)
 rename doc/source/{vif_types.rst => user/vif-types.rst} (100%)

diff --git a/doc/source/index.rst b/doc/source/index.rst
index e0f56a0b..c5df9fa7 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -2,16 +2,6 @@
 os-vif
 ======
 
-.. toctree::
-   :maxdepth: 2
-
-   vif_types
-   host_info
-   usage
-   plugins/ovs
-   plugins/linux-bridge
-   glossary
-
 `os-vif` is a library for plugging and unplugging virtual interfaces (VIFs) in
 OpenStack. It provides:
 
@@ -25,3 +15,23 @@ OpenStack. It provides:
 `os-vif` is intended to define a common model for representing VIF types in
 OpenStack. With the exception of the two included plugins, all plugins for
 other networking backends are maintained in separate code repositories.
+
+Usage Guide
+-----------
+
+.. toctree::
+   :maxdepth: 2
+
+   user/usage
+   user/vif-types
+   user/host-info
+   user/plugins/ovs
+   user/plugins/linux-bridge
+
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   reference/glossary
diff --git a/doc/source/glossary.rst b/doc/source/reference/glossary.rst
similarity index 100%
rename from doc/source/glossary.rst
rename to doc/source/reference/glossary.rst
diff --git a/doc/source/host_info.rst b/doc/source/user/host-info.rst
similarity index 100%
rename from doc/source/host_info.rst
rename to doc/source/user/host-info.rst
diff --git a/doc/source/plugins/linux-bridge.rst b/doc/source/user/plugins/linux-bridge.rst
similarity index 88%
rename from doc/source/plugins/linux-bridge.rst
rename to doc/source/user/plugins/linux-bridge.rst
index 37457fe4..43c215f2 100644
--- a/doc/source/plugins/linux-bridge.rst
+++ b/doc/source/user/plugins/linux-bridge.rst
@@ -18,5 +18,5 @@ The Linux Bridge plugin provides support for the following VIF types:
 
   Refer to :ref:`vif-bridge` for more information.
 
-For information on the VIF type objects, refer to :doc:`../vif_types`. Note
+For information on the VIF type objects, refer to :doc:`/user/vif-types`. Note
 that only the above VIF types are supported by this plugin.
diff --git a/doc/source/plugins/ovs.rst b/doc/source/user/plugins/ovs.rst
similarity index 96%
rename from doc/source/plugins/ovs.rst
rename to doc/source/user/plugins/ovs.rst
index 91b45166..61693d76 100644
--- a/doc/source/plugins/ovs.rst
+++ b/doc/source/user/plugins/ovs.rst
@@ -56,7 +56,7 @@ The Open vSwitch plugin provides support for the following VIF types:
 
   .. versionadded:: 1.5.0
 
-For information on the VIF type objects, refer to :doc:`../vif_types`. Note
+For information on the VIF type objects, refer to :doc:`/user/vif-types`. Note
 that only the above VIF types are supported by this plugin.
 
 __ http://docs.openvswitch.org/en/latest/howto/dpdk/
diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst
similarity index 100%
rename from doc/source/usage.rst
rename to doc/source/user/usage.rst
diff --git a/doc/source/vif_types.rst b/doc/source/user/vif-types.rst
similarity index 100%
rename from doc/source/vif_types.rst
rename to doc/source/user/vif-types.rst