openstack/openstack-manuals
Code Issues Proposed changes

[contributor] add writing documentation chapter

Browse Source 
Change-Id: I2d3ea565e5421fe93ee32e8b998984ec1e1ae6a6
Implements: blueprint contributor-guide-reorg
This commit is contained in:
KATO Tomoyuki 2016-07-20 20:58:32 +09:00
parent 3c90965a3b
commit c26182e2e7
2 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/contributor-guide/source/index.rst
View File

@ -17,15 +17,13 @@ Contents
:maxdepth: 2 :maxdepth: 2
quickstart.rst quickstart.rst
additional-git-workflow.rst
doc-bugs.rst doc-bugs.rst
docs-review.rst docs-review.rst
team-structure.rst team-structure.rst
blueprints-and-specs.rst blueprints-and-specs.rst
api-guides.rst api-guides.rst
project-install-guide project-install-guide
topic-structure.rst writing-docs.rst
topic-tags.rst
writing-style.rst writing-style.rst
ui-text-guidelines.rst ui-text-guidelines.rst
rst-conv.rst rst-conv.rst

23
doc/contributor-guide/source/writing-docs.rst Normal file
View File

@ -0,0 +1,23 @@
=====================
Writing documentation
=====================
This chapter describes what documentation contributors should follow
to ensure consistency throughout all technical publications.
You need to understand :doc:`blueprints-and-specs` before you start
writing. When writing documentation, follow:
* :doc:`writing-style`
* :doc:`rst-conv`
* :doc:`json-conv`
You can :doc:`build your documentation locally <docs-builds>`
to determine if your change renders properly.
.. toctree::
:maxdepth: 2
topic-structure.rst
topic-tags.rst
additional-git-workflow.rst