rearrange existing documentation according to the new standard layout

Change-Id: I0fb178d0b6ebf7ebafc6e2766c8c5efc5d8cc60e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

4 files changed, 21 insertions, 183 deletions

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 089694f..aeae34f 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,186 +1,17 @@
-glance_store
-============
+==============
+ glance_store
+==============
 
 The glance_store library supports the creation, deletion and gather of data
 assets from/to a set of several, different, storage technologies.
 
-glance_store Manual Pages
-=========================
-
 .. toctree::
    :maxdepth: 1
 
-   Module Hierarchy <api/modules>
-
-* :ref:`modindex`
-
-
-Store Drivers
-=============
-
-.. toctree::
-   :maxdepth: 1
-
-   drivers/index
-
-Release Notes
-=============
-
-0.10.0
-------
-
-* Updated from global requirements
-* Imported Translations from Zanata
-* ATTN: After upgrading to glance_store 0.10.1 store options defined in config files under [DEFAULT] section will not work. Logic taking them was removed after deprecation period.
-
-* be3d7a6 Remove useless config.py file
-* 1517275_: vmware: check for response body in error conditions
-* 1323975_: remove default=None for config options
-* d59254e: Remove deprecated glance_store opts from default section
-* 1501443_: Improving GlanceStoreException
-* 1502332_: '_' is used by i18n
-* cc36d53: VMware: Fix missing space in error message
-* c2b8702: Handle swift store's optional dependency
-* 1485792_: Catch InvalidURL when requesting store size
-
-.. _1517275: https://bugs.launchpad.net/glance-store/+bug/1517275
-.. _1323975: https://bugs.launchpad.net/glance/+bug/1323975
-.. _1501443: https://bugs.launchpad.net/glance-store/+bug/1501443
-.. _1502332: https://bugs.launchpad.net/glance-store/+bug/1502332
-.. _1485792: https://bugs.launchpad.net/glance-store/+bug/1485792
-
-0.9.0
------
-
-* s3-proxy-support_: Proxy support to S3 Store
-* rados-timeout_: Better handling of glance-api connections to rbd store
-
-.. _s3-proxy-support: https://blueprints.launchpad.net/glance/+spec/http-proxy-support-for-s3
-.. _rados-timeout: https://bugs.launchpad.net/glance-store/+bug/1469246
-
-
-0.6.0
------
-
-* Dropped py26 support
-* Disable propagating BadStoreConfiguration
-* 1454695_: Sync with global-requirements
-* Handle optional dependency in vmware store
-
-.. _1454695: https://bugs.launchpad.net/glance-store/+bug/1454695
-
-0.5.0
------
-
-* 1449639_: Fix failure when creating an image which already exists in the RBD store
-* 1444663_: Correctly instantiate Forbidden exception
-* 1428257_: Do not raise an exception when a duplicate path on filesystem store is used. Instead emmit a warning
-* 1422699_: Propagate BadStoreConfiguration to library user
-* Initialize vmware session during store creation
-
-.. _1449639: https://bugs.launchpad.net/glance-store/+bug/1449639
-.. _1444663: https://bugs.launchpad.net/glance-store/+bug/1444663
-.. _1428257: https://bugs.launchpad.net/glance-store/+bug/1428257
-.. _1422699: https://bugs.launchpad.net/glance-store/+bug/1422699
-
-0.4.0
------
-* Deprecate the gridfs store
-* Use oslo_config.cfg.ConfigOpts in glance_store
-* 1426767_: Make dependency on boto entirely conditional
-* 1429785_: Fix timeout during upload from slow resource
-* 1418396_: Throw NotFound exception when template is gone
-* Correct such logic in store.get() when chunk_size param provided
-
-.. _1426767: https://bugs.launchpad.net/glance-store/+bug/1426767
-.. _1429785: https://bugs.launchpad.net/glance-store/+bug/1429785
-.. _1418396: https://bugs.launchpad.net/glance-store/+bug/1418396
-
-0.3.0
------
-*  Deprecate VMware store single datastore options
-*  VMware: Support Multiple Datastores. This adds a new config option
-   ``vmware_datastores`` to configure multiple datastores.
-
-0.2.0
-------
-
-* 1425617_: Support for deleting images stored as SLO in Swift
-* Enable DRIVER_REUSABLE for vmware store
-
-.. _1425617: https://bugs.launchpad.net/glance-store/+bug/1425617
-
-0.1.12
-------
-
-* Show fully qualified store name in update_capabilities() logging
-* Move to hacking 0.10
-* Fix sorting query string keys for arbitrary url schemes
-* Remove duplicate key
-* Add coverage report to run_test.sh
-* Use a named enum for capability values
-* Convert httpretty tests to requests-mock
-
-0.1.11
-------
-
-* 1402354_: Check VMware session before uploading image
-* Add capabilities to storage driver
-* Replace snet config with endpoint config. Instead of constructing a URL with
-  a prefix from what is returned by auth, specify the URL via configuration.
-* 1413852_: Remove retry on failed uploads to VMware datastore
-* 1401778_: Validate metadata JSON file. Metadata JSON schema file should
-  be valid objects. This JSON object should contain keys 'id', 'mountpoint' and
-  value of both keys should be string. Example of valid metadata JSON::
-
-    1. If there is only one mountpoint-
-    {
-      "id": "f0781415-cf81-47cd-8860-b83f9c2a415c",
-      "mountpoint": "/var/lib/glance/images/"
-    }
-
-    2. If there are more than one mountpoints-
-    [
-      {
-        "id": "f0781415-cf81-47cd-8860-b83f9c2a415c",
-        "mountpoint": "/var/lib/glance/images1/"
-      },
-      {
-        "id": "asd81415-cf81-47cd-8860-b83f9c2a415c",
-        "mountpoint": "/var/lib/glance/images2/"
-      }
-    ]
-
-* Add needed extra space to error message
-* 1375857_: Define a new parameter to pass CA cert file. This change adds a new
-  parameter for the swift store driver that allows to speficy the name of the CA
-  cert file to use in the SSL connections for verifying certificates. This
-  parameter is passed to the swiftclient in the creation of the connection.
-  The parameter is called ``swift_store_cacert``.
-* 1379798_: Raise appropriate exception if socket error occurs
-* Swift Store to use Multiple Containers. Swift Store will now use multiple
-  containers in single-tenant mode in order to avoid swift rate limiting on a
-  single container.
-* Remove deprecated options
-* Correct GlanceStoreException to provide valid message - glance_store
-* 1350010_: VMware store: Re-use api session token
-
-.. _1402354: https://bugs.launchpad.net/glance-store/+bug/1402354
-.. _1413852: https://bugs.launchpad.net/glance-store/+bug/1413852
-.. _1401778: https://bugs.launchpad.net/glance-store/+bug/1401778
-.. _1375857: https://bugs.launchpad.net/glance-store/+bug/1375857
-.. _1379798: https://bugs.launchpad.net/glance-store/+bug/1379798
-.. _1350010: https://bugs.launchpad.net/glance-store/+bug/1350010
-
-0.0.1a1
--------
-
-* Initial release of glance_store_.
-
-.. _glance_store: https://wiki.openstack.org/wiki/Glance/Store
+   user/index
+   reference/index
 
-Indices and tables
-==================
+.. rubric:: Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
new file mode 100644
index 0000000..c654ff7
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,8 @@
+==============================
+ glance-store Reference Guide
+==============================
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex
diff --git a/doc/source/drivers/index.rst b/doc/source/user/drivers.rst
index 50d47d0..fecf3a0 100644
--- a/doc/source/drivers/index.rst
+++ b/doc/source/user/drivers.rst
@@ -24,11 +24,3 @@ below the table of supported drivers and maintainers:
 +-------------------+---------------------+------------------------------------+------------------+
 | Sheepdog          |  YAMADA Hideki      |  yamada.hideki@lab.ntt.co.jp       |   yamada-h       |
 +-------------------+---------------------+------------------------------------+------------------+
-
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..6c16d5a
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,7 @@
+=================================
+ glance-store User Documentation
+=================================
+
+.. toctree::
+
+   drivers