diff options
| author | Brian Rosmaita <rosmaita.fossdev@gmail.com> | 2018-05-02 12:06:53 -0400 |
|---|---|---|
| committer | Brian Rosmaita <rosmaita.fossdev@gmail.com> | 2018-05-02 12:12:13 -0400 |
| commit | eb6041deb2458b53af020f0d5ad4e19069c9ef91 (patch) | |
| tree | 56b6c330d34df31e6992106fa2408966e9709352 /doc | |
| parent | d0657add8222cd14809cd00a780f1870ace3a9e2 (diff) | |
| download | glance_store-eb6041deb2458b53af020f0d5ad4e19069c9ef91.tar.gz | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/index.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index aeae34f..78b2375 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` - |