Difference between revisions of "Barbican/Documentation"
(→API Reference) |
(→Developer Documentation) |
||
| Line 34: | Line 34: | ||
The source for the developer documentation lives in the main Barbican repo in RST format https://github.com/openstack/barbican/tree/master/doc/source | 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 | ||
Revision as of 04:28, 10 October 2014
Contents
Barbican Documentation
Installation 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
TODO: Figure out where this should be developed during incubation
Eventually, this guide should end up in http://github.com/openstack/openstack-manuals
Configuration Gude
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
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
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
These docs are aimed at developer contributors and are 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
