From 114dfe1f49c29e5c9ca54c230da1be2ca4c4106a Mon Sep 17 00:00:00 2001
From: chenxing <chason.chan@foxmail.com>
Date: Mon, 24 Jul 2017 22:10:58 +0800
Subject: [PATCH] Rearrange existing documentation to fit the new standard
 layout

For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partially-Implements: blueprint queens-doc-restructure

Co-Authored-By: Kurt Taylor <kurt.r.taylor@gmail.com>
Change-Id: Iab93bf023a13b953a31152b91d4fea0fa75bf2d0
(cherry picked from commit 5493fb64e11d2ec961c440dbeb9a71b033f3be0b)
---
 doc/{ => source/admin}/image-building.rst     |  0
 doc/source/admin/index.rst                    | 18 ++++++++++++
 .../template-override/opendaylight-source.rst |  0
 .../admin}/template-override/ovs-dpdk.rst     |  0
 doc/{ => source}/conf.py                      |  0
 doc/{ => source/contributor}/CONTRIBUTING.rst |  0
 doc/{ => source/contributor}/bug-triage.rst   |  0
 doc/source/contributor/index.rst              | 17 +++++++++++
 .../contributor}/running-tests.rst            |  0
 doc/{ => source}/index.rst                    | 28 ++++++-------------
 setup.cfg                                     |  2 +-
 11 files changed, 44 insertions(+), 21 deletions(-)
 rename doc/{ => source/admin}/image-building.rst (100%)
 create mode 100644 doc/source/admin/index.rst
 rename doc/{ => source/admin}/template-override/opendaylight-source.rst (100%)
 rename doc/{ => source/admin}/template-override/ovs-dpdk.rst (100%)
 rename doc/{ => source}/conf.py (100%)
 rename doc/{ => source/contributor}/CONTRIBUTING.rst (100%)
 rename doc/{ => source/contributor}/bug-triage.rst (100%)
 create mode 100644 doc/source/contributor/index.rst
 rename doc/{ => source/contributor}/running-tests.rst (100%)
 rename doc/{ => source}/index.rst (84%)

diff --git a/doc/image-building.rst b/doc/source/admin/image-building.rst
similarity index 100%
rename from doc/image-building.rst
rename to doc/source/admin/image-building.rst
diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
new file mode 100644
index 0000000000..4724b3bb22
--- /dev/null
+++ b/doc/source/admin/index.rst
@@ -0,0 +1,18 @@
+===================
+Administrator Guide
+===================
+
+Building Container Images
+-------------------------
+
+If you are a system administrator running Kolla, this section contains
+information that should help you understand how to build container image
+or build some images using ``--template-override``.
+
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   image-building
+   template-override/*
diff --git a/doc/template-override/opendaylight-source.rst b/doc/source/admin/template-override/opendaylight-source.rst
similarity index 100%
rename from doc/template-override/opendaylight-source.rst
rename to doc/source/admin/template-override/opendaylight-source.rst
diff --git a/doc/template-override/ovs-dpdk.rst b/doc/source/admin/template-override/ovs-dpdk.rst
similarity index 100%
rename from doc/template-override/ovs-dpdk.rst
rename to doc/source/admin/template-override/ovs-dpdk.rst
diff --git a/doc/conf.py b/doc/source/conf.py
similarity index 100%
rename from doc/conf.py
rename to doc/source/conf.py
diff --git a/doc/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst
similarity index 100%
rename from doc/CONTRIBUTING.rst
rename to doc/source/contributor/CONTRIBUTING.rst
diff --git a/doc/bug-triage.rst b/doc/source/contributor/bug-triage.rst
similarity index 100%
rename from doc/bug-triage.rst
rename to doc/source/contributor/bug-triage.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000000..13430a481f
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,17 @@
+============
+Development
+============
+
+Contributing
+------------
+
+This guide is to tell someone who would like to contribute to
+Kolla project. Following this guide to propose your first patch for Kolla.
+And we are welcome everyone to join our project!
+
+.. toctree::
+   :maxdepth: 2
+
+   CONTRIBUTING.rst
+   running-tests
+   bug-triage
diff --git a/doc/running-tests.rst b/doc/source/contributor/running-tests.rst
similarity index 100%
rename from doc/running-tests.rst
rename to doc/source/contributor/running-tests.rst
diff --git a/doc/index.rst b/doc/source/index.rst
similarity index 84%
rename from doc/index.rst
rename to doc/source/index.rst
index dafbca5167..b5635defd7 100644
--- a/doc/index.rst
+++ b/doc/source/index.rst
@@ -37,30 +37,18 @@ example:
 
     https://docs.openstack.org/kolla/mitaka/
 
-
-Kolla Overview
-==============
+Administrator Guide
+===================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   image-building
+   admin/index
 
-Developer Docs
-==============
+Contributor Guide
+=================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   CONTRIBUTING
-   running-tests
-   bug-triage
-
-Template Override Docs
-======================
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   template-override/*
+   contributor/index
diff --git a/setup.cfg b/setup.cfg
index 9e25404db1..346c2d6193 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -46,7 +46,7 @@ setup-hooks =
 [build_sphinx]
 all_files = 1
 build-dir = doc/build
-source-dir = doc
+source-dir = doc/source
 warning-is-error = 1
 
 [build_releasenotes]