Difference between revisions of "Documentation"
(→OpenStack documentation) |
(→OpenStack administration and configuration) |
||
| Line 30: | Line 30: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| − | + | ! Published doc !! Source repository | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/havana/config-reference/content/ Configuration Reference] || https://github.com/openstack/openstack-manuals/tree/master/doc/config-reference | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/admin-guide-cloud/content/ Cloud Administrator Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/admin-guide-cloud | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/high-availability-guide/content/index.html High Availability Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/high-availability-guide | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/ops/ Operations Guide] || https://github.com/openstack/operations-guide | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/security-guide/content/ Security Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/security-guide | |
|- | |- | ||
| − | + | | [http://docs.openstack.org/image-guide/content/ Virtual Machine Image Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide | |
|- | |- | ||
|} | |} | ||
Revision as of 18:05, 11 December 2013
|
Join Our Bug Day
We need your help. Join our Documentation Bug Day on Friday 20th December, 2013. |
Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on docs.openstack.org/developer for example. For official documentation, see docs.openstack.org. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site.
There's also an OpenStack documentation mailing list and IRC channel at #openstack-doc.
OpenStack documentation
OpenStack APIs
API reference documentation
API specifications
- OpenStack Compute Developer Guide API 2
- OpenStack Image Service Developer Guide API 1.0
- OpenStack Object Storage Developer Guide API 1.0
- OpenStack Identity Service Developer Guide API 2.0
- Openstack Network Service Developer Guide API 2.0
- OpenStack Block Storage Developer Guide API 2.0
OpenStack administration and configuration
Source repository
- - Installation, administration, configuration, and user guides
OpenStack user guides
Source Repositories
Doc source is on GitHub. Everyone can propose merges to docs, see Documentation/HowTo. Here are the repositories that build to docs.openstack.org.
For a complete listing of which docs are built, including details about source and target locations, see Documentation/Builds.
- http://github.com/openstack/openstack-manuals - Installation, administration, configuration, and user guides
- http://github.com/openstack/api-site - API Quick Start and API Reference page
- http://github.com/openstack/compute-api - Compute API v2 and Extensions Reference
- http://github.com/openstack/database-api - Database API
- http://github.com/openstack/identity-api - Identity Service API Reference
- http://github.com/openstack/image-api - Image Service API Reference
- http://github.com/openstack/object-api - Object Storage API Reference
- http://github.com/openstack/netconn-api - Networking API Reference
- http://github.com/openstack/volume-api - Block Storage Service API Reference
- https://github.com/openstack/operations-guide - Operations Guide
- https://github.com/openstack/openstack-doc-tools - Documentation Tools
Development
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
- OpenStack Object Storage (Swift) Development Guidelines
- OpenStack Compute (Nova) Developer Guide
- OpenStack Image Service (Glance) Developer Docs
- OpenStack Identity Service (Keystone) Developer Docs
- OpenStack Networking (Neutron) Developer Docs
- OpenStack Block Storage (Cinder) Developer Docs
Ideally the above content is geared towards developers.
The content at docs.openstack.org is for OpenStack administrators and application developers.
Releases
Lists current development release and past releases, with links to downloads and release notes (what's new and what's changed in each release as well as known issues and potential workarounds)
Support
How to find or ask for support.
Glossary
- Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.
Project documentation
Development
How to contribute code to OpenStack or develop using the OpenStack projects.
- How to Contribute
- Sign the Contributor agreement
- Design Tenets
- Explanation of the Release cycle
- Coding Standards
- Getting the Code
Launchpad reference
How we use Launchpad to track features, bugs and releases.
Writing documentation
- How to contribute to the documentation
- Conventions to follow when writing documentation
- Documentation checklist
- Documentation build information
- DocImpact
- Troubleshooting doc builds
- Comments on Documentation
