openstack-manuals/doc/doc-contrib-guide/source/writing-docs.rst

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