openstack-manuals/doc/doc-contrib-guide/source/writing-docs.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +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