Merge "Rearrange existing documentation to fit the new standard layout"3.1.0

6 files changed, 82 insertions, 2 deletions

diff --git a/doc/source/functional_tests.rst b/doc/source/contributor/functional_tests.rst
index 6af85ba..6af85ba 100644
--- a/doc/source/functional_tests.rst
+++ b/doc/source/contributor/functional_tests.rst
diff --git a/doc/source/unit_tests.rst b/doc/source/contributor/unit_tests.rst
index 988740d..988740d 100644
--- a/doc/source/unit_tests.rst
+++ b/doc/source/contributor/unit_tests.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e55b6bb..13d95c5 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -28,8 +28,8 @@ Alternatively, you can create a client instance using the keystoneauth session A
     >>> cinder.volumes.list()
     []
 
-Command-line Tool
-=================
+User Guides
+===========
 In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables::
 
     export OS_USERNAME=user
@@ -41,6 +41,28 @@ Once you've configured your authentication parameters, you can run ``cinder help
 
 See also :doc:`/cli/index` for detailed documentation.
 
+.. toctree::
+   :maxdepth: 2
+
+   user/cinder
+
+Command-Line Reference
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   cli/shell
+   cli/no_auth
+
+Developer Guides
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributor/functional_tests
+   contributor/unit_tests
 
 Release Notes
 =============
diff --git a/doc/source/user/cinder.rst b/doc/source/user/cinder.rst
new file mode 100644
index 0000000..50fb644
--- /dev/null
+++ b/doc/source/user/cinder.rst
@@ -0,0 +1,58 @@
+==============================
+:program:`cinder` CLI man page
+==============================
+
+.. program:: cinder
+.. highlight:: bash
+
+
+SYNOPSIS
+========
+
+:program:`cinder` [options] <command> [command-options]
+
+:program:`cinder help`
+
+:program:`cinder help` <command>
+
+
+DESCRIPTION
+===========
+
+The :program:`cinder` command line utility interacts with OpenStack Block
+Storage Service (Cinder).
+
+In order to use the CLI, you must provide your OpenStack username, password,
+project (historically called tenant), and auth endpoint. You can use
+configuration options :option:`--os-username`, :option:`--os-password`,
+:option:`--os-tenant-name` or :option:`--os-tenant-id`, and
+:option:`--os-auth-url` or set corresponding environment variables::
+
+    export OS_USERNAME=user
+    export OS_PASSWORD=pass
+    export OS_TENANT_NAME=myproject
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+
+You can select an API version to use by :option:`--os-volume-api-version`
+option or by setting corresponding environment variable::
+
+    export OS_VOLUME_API_VERSION=2
+
+
+OPTIONS
+=======
+
+To get a list of available commands and options run::
+
+    cinder help
+
+To get usage and options of a command::
+
+    cinder help <command>
+
+
+BUGS
+====
+
+Cinder client is hosted in Launchpad so you can view current bugs at
+https://bugs.launchpad.net/python-cinderclient/.
diff --git a/doc/source/no_auth.rst b/doc/source/user/no_auth.rst
index 9885df2..9885df2 100644
--- a/doc/source/no_auth.rst
+++ b/doc/source/user/no_auth.rst
diff --git a/doc/source/shell.rst b/doc/source/user/shell.rst
index 813b769..813b769 100644
--- a/doc/source/shell.rst
+++ b/doc/source/user/shell.rst