openstack/glance_store
Code Issues Proposed changes

Add glance_store disclaimer to docs

Browse Source 
Change Iac83c515e12ec953f4814e7cbeeca33c034d7497 added a statement,
agreed upon at the Ocata design summit, concerning the use-at-your-
own-risk nature of glance_store.  This patch updates the glance_store
docs to carry the same disclaimer.

Change-Id: I513fc391246d52fdf08fcd33012c7bbb677a36ac
This commit is contained in:
Brian Rosmaita 2018-05-02 12:06:53 -04:00
parent d0657add82
commit eb6041deb2
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/index.rst
View File

@ -5,6 +5,15 @@
The glance_store library supports the creation, deletion and gather of data
assets from/to a set of several, different, storage technologies.
.. warning::
This library has been extracted from the Glance source code for the
specific use of the Glance and Glare projects.
The API it exposes is not stable, has some shortcomings, and is not a
general purpose interface. We would eventually like to change this, but for
now using this library outside of Glance or Glare will not be supported by
the core team.
.. toctree::
:maxdepth: 1
@ -16,4 +25,3 @@ assets from/to a set of several, different, storage technologies.
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`