openstack-manuals/doc/contributor-guide/source/writing-docs.rst
Alexandra Settle c099874423 [contrib-guide] Adding vendor specific info
Documenting this in the contrib guide is important as
there is a lot of vendor content coming in.

Reference: http://specs.openstack.org/openstack/docs-specs/specs/kilo/move-driver-docs.html

Change-Id: I0a67a46a2ddb8eca8b200d02bfbf6c2c550e72e0
2016-12-02 13:26:40 +00:00

606 B

Writing documentation

This chapter describes what documentation contributors should follow to ensure consistency throughout all technical publications.

You need to understand blueprints-and-specs before you start writing. When writing documentation, follow:

  • writing-style
  • rst-conv
  • json-conv

You can build your documentation locally <docs-builds> to determine if your change renders properly.

topic-structure.rst topic-tags.rst additional-git-workflow.rst vendor-drivers.rst