From eb6041deb2458b53af020f0d5ad4e19069c9ef91 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Wed, 2 May 2018 12:06:53 -0400 Subject: [PATCH] Add glance_store disclaimer to docs 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 --- doc/source/index.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index aeae34f1..78b2375c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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` -