Blueprint-os-cli-docs
- Launchpad Entry: Design for OpenStack Command-line Interface (CLI) Docs
- Created: Diane Fleming
- Contributors:
Summary
This blueprint describes a plan to automate the reference documentation for the OpenStack command-line interfaces (CLI), such as nova, neutron, keystone, swift, and other commands. Currently, this documentation resides here and is produced manually, though it's cut and paste from the command help output.
The automated documentation would appear in the following books:
| Document | Command Ref |
|---|---|
| OpenStack End User Guide | http://docs.openstack.org/user-guide/content/nova_summary.html |
| OpenStack Admin User Guide | http://docs.openstack.org/user-guide-admin/content/nova_summary.html |
Content is shared between the two user guides.
Blueprint - CLI documentation automation
Audience: End users of OpenStack clouds who perform tasks through the OpenStack command-line clients. Also, developers who create applications on top of OpenStack by using the OpenStack APIs.
Product info: Icehouse, 2014.1
Purpose:
- Automate CLI reference documentation from code.
- Include both the output from nova help, and so on, and the output for each command, such as nova help boot.
Source material:
