Difference between revisions of "Barbican/Documentation"
(→Developer Documentation) |
|||
| Line 31: | Line 31: | ||
== Developer Documentation == | == 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 | 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 | 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. | ||
Revision as of 04:34, 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
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.
