From b7fb1dd1c8e1225b8e8578273dc63799ba89c148 Mon Sep 17 00:00:00 2001
From: Tom Barron <tpb@dyncloud.net>
Date: Mon, 7 Aug 2017 06:55:30 -0400
Subject: [PATCH] doc migration: new directory layout

This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

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

Partial-Bug: #1706181
Needed-By: Iac9a0180a8b1a45f6f1d84020c6d15f457ad92bf
Depends-On: I92cc896bbd505d10c9dc7101bacb4caedf43da8f
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: I9c378a188f9009a82100f5488a936d43536bd5b6
---
 README.rst                                    |  2 +-
 doc/source/{ => contributor}/contributing.rst |  2 +-
 doc/source/contributor/readme.rst             |  1 +
 doc/source/index.rst                          | 10 +++++-----
 doc/source/{ => install}/installation.rst     |  0
 doc/source/readme.rst                         |  1 -
 doc/source/{ => user}/usage.rst               |  6 +++---
 7 files changed, 11 insertions(+), 11 deletions(-)
 rename doc/source/{ => contributor}/contributing.rst (50%)
 create mode 100644 doc/source/contributor/readme.rst
 rename doc/source/{ => install}/installation.rst (100%)
 delete mode 100644 doc/source/readme.rst
 rename doc/source/{ => user}/usage.rst (51%)

diff --git a/README.rst b/README.rst
index e3832736..b77250e1 100644
--- a/README.rst
+++ b/README.rst
@@ -118,7 +118,7 @@ expected to redefine enabled_share_protocols as follows:
        'enabled_share_protocols': ['NFS'],
     }
 
-Contributing
+New Features
 ------------
 
 When implementing a new feature, you may think about making it optional,
diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst
similarity index 50%
rename from doc/source/contributing.rst
rename to doc/source/contributor/contributing.rst
index ed77c126..2aa07077 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/contributing.rst
@@ -1,4 +1,4 @@
 ============
 Contributing
 ============
-.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/contributor/readme.rst b/doc/source/contributor/readme.rst
new file mode 100644
index 00000000..e4a3ad51
--- /dev/null
+++ b/doc/source/contributor/readme.rst
@@ -0,0 +1 @@
+.. include:: ../../../README.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f9b4e174..e00d6978 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -4,17 +4,17 @@
    contain the root `toctree` directive.
 
 Welcome to manila-ui's documentation!
-========================================================
+=====================================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   readme
-   installation
-   usage
-   contributing
+   contributor/readme
+   install/installation
+   user/usage
+   contributor/contributing
 
 Indices and tables
 ==================
diff --git a/doc/source/installation.rst b/doc/source/install/installation.rst
similarity index 100%
rename from doc/source/installation.rst
rename to doc/source/install/installation.rst
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
deleted file mode 100644
index 38ba8043..00000000
--- a/doc/source/readme.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../README.rst
\ No newline at end of file
diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst
similarity index 51%
rename from doc/source/usage.rst
rename to doc/source/user/usage.rst
index 11b49fd8..0d50f1b6 100644
--- a/doc/source/usage.rst
+++ b/doc/source/user/usage.rst
@@ -1,7 +1,7 @@
-========
+=====
 Usage
-========
+=====
 
 To use manila-ui in a project::
 
-    import manila_ui
\ No newline at end of file
+    import manila_ui