a6c3d1dbd3
Converts the Blueprints and specifications section of the HowTo wikipage: https://wiki.openstack.org/wiki/Documentation/HowTo#When_to_write_a_blueprint_description_in_docs-specs Change-Id: If2f4c80a69e67a94004125efc4ab77faf89ef695 Implements: blueprint docs-contributor-guide
1.6 KiB
1.6 KiB
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.
Use blueprints and specifications:
- When adding large sections to an existing document to ensure involvement of the core doc 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. For more information, see: Blueprints and specifications.
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: doc_bugs.