[contributor] add writing documentation chapter
Change-Id: I2d3ea565e5421fe93ee32e8b998984ec1e1ae6a6 Implements: blueprint contributor-guide-reorg
This commit is contained in:
parent
3c90965a3b
commit
c26182e2e7
@ -17,15 +17,13 @@ Contents
|
||||
:maxdepth: 2
|
||||
|
||||
quickstart.rst
|
||||
additional-git-workflow.rst
|
||||
doc-bugs.rst
|
||||
docs-review.rst
|
||||
team-structure.rst
|
||||
blueprints-and-specs.rst
|
||||
api-guides.rst
|
||||
project-install-guide
|
||||
topic-structure.rst
|
||||
topic-tags.rst
|
||||
writing-docs.rst
|
||||
writing-style.rst
|
||||
ui-text-guidelines.rst
|
||||
rst-conv.rst
|
||||
|
23
doc/contributor-guide/source/writing-docs.rst
Normal file
23
doc/contributor-guide/source/writing-docs.rst
Normal 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
|
Loading…
Reference in New Issue
Block a user