From 0ff0cbf74afc906775f889879f961851ba65e28f Mon Sep 17 00:00:00 2001
From: Matt Riedemann <mriedem.os@gmail.com>
Date: Tue, 16 Oct 2018 10:13:30 -0400
Subject: [PATCH] Move cinder-manage page to cli doc subtree

Since we have a CLI reference and specific doc subtree the
cinder-manage docs should live there. This moves the cinder-manage
page from man/ to cli/ and adds a redirect link.

Change-Id: If99416e8a382d2a6571412742276dccc591d180c
---
 doc/source/_extra/.htaccess               |  1 +
 doc/source/{man => cli}/cinder-manage.rst |  0
 doc/source/cli/index.rst                  | 17 +++++++++++++++++
 doc/source/conf.py                        |  5 ++++-
 doc/source/index.rst                      |  1 -
 5 files changed, 22 insertions(+), 2 deletions(-)
 create mode 100644 doc/source/_extra/.htaccess
 rename doc/source/{man => cli}/cinder-manage.rst (100%)

diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess
new file mode 100644
index 00000000000..e3a230ce9e1
--- /dev/null
+++ b/doc/source/_extra/.htaccess
@@ -0,0 +1 @@
+redirectmatch 301 ^/cinder/([^/]+)/man/cinder-manage.html$ /cinder/$1/cli/cinder-manage.html
diff --git a/doc/source/man/cinder-manage.rst b/doc/source/cli/cinder-manage.rst
similarity index 100%
rename from doc/source/man/cinder-manage.rst
rename to doc/source/cli/cinder-manage.rst
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 5a66a19b560..c3e9c9c38eb 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -2,6 +2,23 @@
 Command-Line Interface Reference
 ================================
 
+In this section you will find information on Cinder's command line utilities.
+
+Cinder Management Commands
+--------------------------
+
+These commands are used to manage existing installations. They are designed to
+be run by operators in an environment where they have direct access to the
+Cinder database.
+
+.. toctree::
+   :maxdepth: 1
+
+   cinder-manage
+
+Additional Tools and Information
+--------------------------------
+
 .. toctree::
    :maxdepth: 1
 
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 5a1b99faf43..89df5368c9d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -149,7 +149,7 @@ modindex_common_prefix = ['cinder.']
 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
 
 man_pages = [
-    ('man/cinder-manage', 'cinder-manage', u'Cloud controller fabric',
+    ('cli/cinder-manage', 'cinder-manage', u'Cloud controller fabric',
      [u'OpenStack'], 1)
 ]
 
@@ -189,6 +189,9 @@ html_theme = 'openstackdocs'
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Add any paths that contain "extra" files, such as .htaccess.
+html_extra_path = ['_extra']
+
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%Y-%m-%d %H:%M'
diff --git a/doc/source/index.rst b/doc/source/index.rst
index bcaf03a7ab7..28f602979aa 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -78,7 +78,6 @@ Full documentation on the python-cinderclient is in the
    :maxdepth: 2
 
    cli/index
-   cinder-manage Usage <man/cinder-manage>
 
 Contributor/Developer Docs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~