References to doc contributor guide

Document guide is referenced only instead of included in its entirety, for better readability and user-friendliness.

Story: 2002074
Task: 19735

Change-Id: Icaf2fbd784f300d26153de78b1c5e95b6a003990
Signed-off-by: visnyei <andrea.visnyei@nokia.com>
This commit is contained in:
visnyei 2018-06-15 10:51:46 +02:00 committed by Andrea Visnyei
parent a531ad6801
commit 3f332ef012
3 changed files with 20 additions and 0 deletions

View File

@ -21,4 +21,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>`_`.