Content specification¶

Blueprints and specifications¶

The Documentation team uses specifications in the docs-specs repository to maintain large changes. Approved specifications are published at Documentation Program Specifications. For tracking purposes, a blueprint is created for each specification. It is also good practice to contact the specialty team for the book you want to change to discuss your changes before starting work.

Use blueprints and specifications:

• When adding large sections to an existing document to ensure involvement of the docs core team.
• When adding an entirely new deliverable to the docs project.
• For any work that requires both content and tooling changes, such as addition of the API reference site.
• For any large reorganization of a deliverable or set of deliverables.
• For automation work that needs to be designed prior to proposing a patch.
• For work that should definitely be discussed at a summit.

A specification needs two +2 votes from the docs-specs-core team. See the current list of docs-specs core team.

Use bugs against openstack-manuals or openstack-api-site:

• For known content issues, even if you have to do multiple patches to close the bug.
• To add content that is just missing.
• For known errors in a document.

For more information, see Documentation bugs.

Release-specific documentation¶

The Installation Tutorials and Guides, Configuration Reference, and Networking Guide are released at release time, with draft material published to https://docs.openstack.org/draft/draft-index.html. The rest of the guides are continuously released.

To patch for the release-specific documentation, you should generally patch to master branch with “backport: xxxx” (for example, backport: kilo) in the commit message.

For these guides, the docs.openstack.org site defaults to the current release, with the previous two releases being available under the More Releases & Languages drop-down. At release time, the documentation release team will update the default page to the new release, and remove the link to the oldest release. These docs are still available online for people who have direct URLs to the content, but they are no longer linked from the main site. For books written in DocBook XML, these old versions are clearly marked with the release name in red down the left-hand margin. We are currently developing a similar method of marking older books written in RST. The core team tracks usage of older versions, and as usage falls, can remove them entirely.

Continuously released documentation¶

These guides cover multiple versions and we follow the general release information. The guides cover the latest two versions, for example Juno and Kilo. The following exceptions apply:

• Operations Guide: Icehouse target, revised specifically to target that release
• HA Guide: Updated last at Havana timeframe, still needs updates

Licenses¶

This section shows the license indicators as of March 20, 2015.

• OpenStack Architecture Design Guide: Apache 2.0 and CC-by-sa 3.0
• OpenStack Administrator Guide: Apache 2.0 and CC-by-sa 3.0
• OpenStack Install Guides (all): Apache 2.0
• OpenStack High Availability Guide: Apache 2.0
• OpenStack Configuration Reference: Apache 2.0
• OpenStack Networking Guide: Apache 2.0
• OpenStack Security Guide: CC-by 3.0
• Virtual Machine Image Guide: CC-by 3.0
• OpenStack Operations Guide: CC-by 3.0
• OpenStack End User Guide: CC-by 3.0
• Command-Line Interface Reference: CC-by 3.0
• Contributor dev docs (docs.openstack.org/developer/<projectname>): none indicated in output; Apache 2.0 in repo
• OpenStack API Quick Start: none indicated in output; Apache 2.0 in repo
• API Complete Reference: none indicated in output; Apache 2.0 in repo
• Infrastructure User Manual: none indicated in output; CC-by 3.0 in repo

What to do to make more consistent output:

• OpenStack Architecture Design Guide: Apache 2.0 and CC-by 3.0
• OpenStack Administrator Guide: Apache 2.0 and CC-by 3.0
• OpenStack Install Guides (all): Apache 2.0 and CC-by 3.0
• OpenStack High Availability Guide: Apache 2.0 and CC-by 3.0
• OpenStack Security Guide: CC-by 3.0
• Virtual Machine Image Guide: CC-by 3.0
• OpenStack Operations Guide: CC-by 3.0
• OpenStack End User Guide: CC-by 3.0

These guides are created by “scraping” code:

• OpenStack Configuration Reference: Apache 2.0 and CC-by 3.0
• Command-Line Interface Reference: Apache 2.0 and CC-by 3.0

These guides have no indicator in output:

• Contributor dev docs (docs.openstack.org/developer/<projectname>): none indicated in output; Apache 2.0 in repo
• OpenStack API Quick Start: none indicated in output; Apache 2.0 in repo
• API Complete Reference: none indicated in output; Apache 2.0 in repo

This guide has a review in place to get a license indicator in output:

• Infrastructure User Manual: none indicated in output; CC-by 3.0 in repo