Difference between revisions of "Documentation"
|Line 38:||Line 38:|
| Current PTL
| Current PTL
| - (at)(dot)com, IRC:
Revision as of 03:54, 13 February 2017
The focus here is the creation, maintenance and organization of the OpenStack documentation found at the http://docs.openstack.org site and the wiki.openstack.org site. While the Docs team helps create a good framework, it's the entire OpenStack community -- and especially contributors like you -- that provides the expert content and corrections for the documentation.
|OpenStack Documentation Project Team|
|Full name||OpenStack Documentation|
|Source code||openstack-manuals; api-site - see doc builds for full list|
|Bug tracker||http://bugs.launchpad.net/openstack-manuals and http://bugs.launchpad.net/openstack-api-site|
|Developer doc||Documentation HowTo|
|Current PTL||Alexandra Settle - a.settle(at)outlook(dot)com, IRC: asettle|
|Meetings||Documentation team meeting|
|IRC channel||#openstack-doc on Freenode (more about OpenStack on IRC)|
|Mailing list||OpenStack documentation mailing list|
Published docs and their location
The public interface to all documentation is the docs.openstack.org web site. It contains continuously updated manuals. If you like to edit one of these, see Documentation source and target locations for a list of documents and their source repositories.
Doc source is on GitHub. Everyone can propose changes 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://git.openstack.org/cgit/openstack/openstack-manuals - Installation, administration, configuration, architecture design guide and user guides
- http://git.openstack.org/cgit/openstack/api-site - API Quick Start and API Complete Reference page
- http://git.openstack.org/cgit/openstack/operations-guide - Operations Guide
- http://git.openstack.org/cgit/openstack/openstack-doc-tools - Documentation Tools
- http://git.openstack.org/cgit/openstack/openstackdocstheme - Sphinx theme for RST documentation
- http://git.openstack.org/cgit/openstack/security-doc - Security Guide
- http://git.openstack.org/cgit/openstack/training-guides - Training Guides
- http://git.openstack.org/cgit/openstack/ha-guide - High Availability Guide
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.
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)
How to find or ask for support.
- Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.
This is general information about OpenStack.
How to contribute code to OpenStack or develop using the OpenStack projects.
- Developer's Guide in the Infra Manual
- How to Contribute
- Sign the Contributor agreement
- Design Tenets
- Project Team Guide
- Coding Standards
- Getting the Code
How we use Launchpad to track features, bugs and releases.
First, read the Documentation Contributor Guide.
- How to contribute to the documentation
- Conventions to follow when writing documentation
- DocBook to RST Migrations
- Troubleshooting doc builds
- Comments on Documentation
- Rackspace's Writers Guide
- Review Guidelines
- Mitaka Documentation Testing - Installation Guide and Configuration Reference
- How to make a documentation release
- Documentation user analysis
Admin access to to the documentation site
There are some areas where only trusted infrastructure or doc team members have access to configure or manage part of the documentation site. Examples include:
- FTP credentials to the Cloud Sites that houses the files for docs.openstack.org and developer.openstack.org.
- Google Custom Search Engine (CSE) configuration.
- Google Analytics account information and configuration.
For these shared identities, we use the following process to ensure limited access to the information that grants access.
- At the Summit or another in-person meeting, ensure we verify identities with IDs similar to a GPG party.
- With those identities and shared trust in place, create a server with a place to store the account information.
- Enable access to the shared account info by granting access to the server.
Currently the infrastructure core team and Docs PTL has access to the FTP credentials. The Docs PTL has access to the Google CSE information and the Google Analytics account information. The Docs PTL can grant access to the shared Google information. The infrastructure core team can grant access to the FTP credentials.
There are many additional publications about OpenStack by third party publishers. Please search for them on your favorite bookseller site.