openstack/deb-barbican
Code Issues Proposed changes

Update and reorganize the doc landing page.

Browse Source 
Change-Id: Ica4712abb781e270b1fc7210c6705977db10a691
This commit is contained in:
Douglas Mendizábal 2016-02-17 20:05:27 -06:00
parent 09e1581f2c
commit 0d8169c4d2
1 changed files with 55 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
doc/source/index.rst
View File

@ -1,33 +1,69 @@
Welcome to Barbican's developer documentation!
==============================================
Barbican is an OpenStack service that provides secure storage,
provisioning and management of secret data. This includes keying material such
as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
Barbican is the OpenStack Key Manager service. It provides secure storage,
provisioning and management of secret data. This includes keying material
such as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data.
This document describes barbican for contributors of the project, and assumes
that you are already familiar with barbican from an end-user perspective.
Barbican for Users
==================
This documentation is generated by the Sphinx toolkit and lives in the source
tree.
If you're trying to learn how to use barbican, you can start by reading
about :doc:`Secrets in the Barbican API Guide <api/userguide/secrets>`.
Once you're comfortable working with secrets you can dig into the rest of the
API.
Getting Started
===============
.. toctree::
:maxdepth: 1
api/index
contribute/getting_involved
contribute/dependencies
contribute/architecture
contribute/dataflow
contribute/structure
contribute/database_migrations
setup/index
testing
admin-guide-cloud/index
plugin/index
Barbican for Developers
=======================
If you're new to OpenStack development you should start by reading the
`OpenStack Developer's Guide`_.
.. _`OpenStack Developer's Guide`: http://docs.openstack.org/infra/manual/developers.html
Once you've read the OpenStack guide you'll be ready to set up a local barbican
development environment.
.. toctree::
:maxdepth: 1
setup/dev
setup/devstack
When you're ready to dive deeper in to barbican take a look at:
.. toctree::
:maxdepth: 1
contribute/getting_involved
contribute/architecture
contribute/structure
contribute/dataflow
contribute/dependencies
contribute/database_migrations
plugin/index
testing
Barbican for Operators
======================
If you're looking for information for deploying and configuring barbican you
will probably want to read:
.. toctree::
:maxdepth: 1
setup
admin-guide-cloud/index
This documentation is generated by the Sphinx toolkit and lives in the source
tree.
Indices and tables