Fixes index.rst titles and add mascot
Change based on other services docs like Nova and Cinder. Change-Id: If96ad0bedf469934c8e4c7fcbe8c880514ae9489
This commit is contained in:
parent
796a1b13ca
commit
5df6c0cf84
BIN
doc/source/images/mascot.png
Normal file
BIN
doc/source/images/mascot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
@ -1,12 +1,19 @@
|
|||||||
Welcome to the Barbican Project documentation!
|
OpenStack Key Manager (barbican)
|
||||||
==============================================
|
================================
|
||||||
|
|
||||||
|
.. figure:: images/mascot.png
|
||||||
|
:alt: Barbican logo
|
||||||
|
:width: 210
|
||||||
|
|
||||||
|
What is Barbican?
|
||||||
|
-----------------
|
||||||
|
|
||||||
Barbican is the OpenStack Key Manager service. It provides secure storage,
|
Barbican is the OpenStack Key Manager service. It provides secure storage,
|
||||||
provisioning and management of secret data. This includes keying material
|
provisioning and management of secret data. This includes keying material
|
||||||
such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
|
such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
|
||||||
|
|
||||||
API Guide
|
API Guide
|
||||||
==========
|
---------
|
||||||
|
|
||||||
If you're trying to learn how to use barbican, you can start by reading about
|
If you're trying to learn how to use barbican, you can start by reading about
|
||||||
`Secrets in the Barbican API Guide <https://docs.openstack.org/api-guide/key-manager/secrets.html>`__.
|
`Secrets in the Barbican API Guide <https://docs.openstack.org/api-guide/key-manager/secrets.html>`__.
|
||||||
@ -22,13 +29,14 @@ API.
|
|||||||
install/index
|
install/index
|
||||||
configuration/index
|
configuration/index
|
||||||
contributor/index
|
contributor/index
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
api/index.rst
|
api/index.rst
|
||||||
|
|
||||||
Sample Files
|
Sample Files
|
||||||
============
|
------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
@ -39,7 +47,7 @@ Sample Files
|
|||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
|
Loading…
x
Reference in New Issue
Block a user