openstack
/
docs-specs
Code Issues Proposed changes
RETIRED, OpenStack Documentation Specifications
169 Commits 1 Branch 0 Tags 2.5 MiB
Go to file
johnsom 4d20a0afd4 Move administrator guide to project repos 
The number of approved OpenStack projects continues to grow while the
documentation team resources are shrinking. We need a new approach to maintain
the high quality of the OpenStack documentation set.

This specification proposes allowing project teams to manage their
administrator guide content similar to how the api-ref and installation guides
are being managed.

Change-Id: I70592f5c8a415dc1454a89f1012ad50178359953
 		2017-04-11 12:46:56 +00:00
doc/source Fix sphinx warnings 2017-04-11 13:39:13 +01:00
specs Move administrator guide to project repos 2017-04-11 12:46:56 +00:00
tests remove pyc files from the git tree 2014-07-18 21:19:10 +02:00
.gitignore Setup docs-specs gating 2014-07-04 09:28:22 +02:00
.gitreview Add .gitreview 2014-07-04 09:45:41 +02:00
LICENSE Initial docs-specs repository 2014-06-27 07:32:02 -05:00
README.rst Show team and repo badges on README 2016-11-25 14:44:37 +01:00
requirements.txt Fix sphinx warnings 2017-04-11 13:39:13 +01:00
setup.cfg Fix sphinx warnings 2017-04-11 13:39:13 +01:00
setup.py Fix sphinx warnings 2017-04-11 13:39:13 +01:00
tox.ini Fix sphinx warnings 2017-04-11 13:39:13 +01:00

README.rst

Team and repository tags

image

OpenStack Documentation Specifications

This git repository is used to hold approved design specifications for additions to the OpenStack Documentation program. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the docs and supporting tools.

The layout of this repository is:

specs/<release>/

You can find an example spec in doc/source/specs/template.rst. Fill it in with the details of a new blueprint for documentation.

For docs, blueprints are required for larger, coordinated projects but not for small fixes. It's a judgement call for whether you need a spec, so feel free to ask in the #openstack-doc IRC channel or on the openstack-docs mailing list.

To propose a specification for a release-specific doc like the install guides or the configuration reference, add a new file to the specs/<release> directory and post it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad (and the spec links to Launchpad).

Please realize that not all approved blueprints will get fully implemented.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints.

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see https://wiki.openstack.org/wiki/Blueprints.

For more information about working with gerrit, see http://docs.openstack.org/infra/manual/developers.html#development-workflow.

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory. Please do not check in the generated HTML files as a part of your commit.

The files are published at http://specs.openstack.org/openstack/docs-specs.

The git repository is located at http://git.openstack.org/cgit/openstack/docs-specs/.