Difference between revisions of "Barbican/Documentation"
(→Configuration Gude) |
(→API Quick Start) |
||
| Line 33: | Line 33: | ||
== API Quick Start == | == API Quick Start == | ||
| + | This guide is aimed at new users of the Barbican API and should cover only a few use cases to get readers acquainted with the Barbican API. The source currently lives in the main Barbican repo https://github.com/openstack/barbican/blob/master/docs/src/docbkx/ck-gettingstarted.xml | ||
| + | |||
TODO: Figure out where this should be developed during incubation | TODO: Figure out where this should be developed during incubation | ||
Revision as of 05:07, 10 October 2014
Contents
Barbican Documentation
Installation Guide
This DocBook guide should be aimed at deployers of OpenStack clouds. It should probably cover installation for at least one production-ready configuration of Barbican. Currently the source for this guide is in the main Barbican repo, but it's only a place-holder. https://github.com/openstack/barbican/blob/master/docs/src/docbkx/ck-install.xml
The only documented installation is for an insecure development environment, which is documented in the GitHub wiki https://github.com/cloudkeep/barbican/wiki/Barbican-Quick-Start-Guide and is by no means a good substitute for this guide.
TODO: Figure out where this should be developed during incubation
Eventually, this guide should end up in http://github.com/openstack/openstack-manuals
Administration Guide
This DocBook guide should be aimed at operators of OpenStack clouds. It should cover common administration tasks for running Barbican. This guide has not yet been started.
TODO: Figure out where this should be developed during incubation
Eventually, this guide should end up in http://github.com/openstack/openstack-manuals
Configuration Guide
This DocBook guide should be aimed at deployers of OpenStack clouds. It should thoroughly cover all deployment options for Barbican. This guide has not yet been started.
TODO: Figure out where this should be developed during incubation
Eventually, this guide should end up in http://github.com/openstack/openstack-manuals
User Guide
This guide is aimed at users of the Barbican API. The source currently lives in the main Barbican repo https://github.com/openstack/barbican/blob/master/docs/src/docbkx/ck-devguide.xml
TODO: The API definition should be split up into its own repo
TODO: Figure out where this should be developed during incubation
Eventually, this guide should end up in http://github.com/openstack/openstack-manuals
API Quick Start
This guide is aimed at new users of the Barbican API and should cover only a few use cases to get readers acquainted with the Barbican API. The source currently lives in the main Barbican repo https://github.com/openstack/barbican/blob/master/docs/src/docbkx/ck-gettingstarted.xml
TODO: Figure out where this should be developed during incubation
Eventually, this quick start should end up in https://github.com/openstack/api-site
API Reference
The API Reference is currently in the CloudKeep Barbican Wiki. TODO: Update Orders API
In the long term, this wiki should be migrated to a stand-alone api repository to be located at https://github.com/openstack/key-management-api (See https://github.com/openstack/identity-api for example)
Developer Documentation
Barbican
Barbican developer documentation is aimed at developer contributors. They're published to: http://docs.openstack.org/developer/barbican
The source for the developer documentation lives in the main Barbican repo in RST format https://github.com/openstack/barbican/tree/master/doc/source
TODO: Document new plugin guidelines
python-barbicanclient
python-barbicanclient developer documentation is aimed at developers consuming the library in their own applications.
TODO: Configure gates to publish docs to http://docs.openstack.org/developer/python-barbicanclient
The source for the developer documentation should live in the main python-barbicanclient repo in RST format.
