Merge "References to doc contributor guide"

This commit is contained in:
Zuul 2018-08-03 16:01:33 +00:00 committed by Gerrit Code Review
commit 750addd62c
3 changed files with 20 additions and 0 deletions

View File

@ -22,4 +22,5 @@ Code & Documentation Contributor Guide
/common/zuul-status
/code-and-documentation/elastic-recheck
/common/i18n
/code-and-documentation/references-doc-contrib-guide.rst
/code-and-documentation/sandbox-house-rules

View File

@ -15,3 +15,7 @@ communication, which we encourage you to use.
We do not differentiate between the different types of contributions such as
code or documentation therefore you will find guidance in this chapter for all
types.
A detailed description of the documentation tools and processes can be found
in the
`OpenStack Documentation Contributor Guide <https://docs.openstack.org/doc-contrib-guide/index.html>`_.

View File

@ -0,0 +1,15 @@
#########################################
OpenStack Documentation Contributor Guide
#########################################
The `OpenStack Documentation Contributor Guide
<https://docs.openstack.org/doc-contrib-guide/index.html>`_ describes how to
contribute to OpenStack documentation. It contains information on
`writing
<https://docs.openstack.org/doc-contrib-guide/writing-docs.html>`_,
`building
<https://docs.openstack.org/doc-contrib-guide/docs-builds.html>`_, and
`reviewing
<https://docs.openstack.org/doc-contrib-guide/docs-review.html>`_ documents,
as well as best practices and `API documentation guidelines
<https://docs.openstack.org/doc-contrib-guide/api-guides.html>`_`.