From 3f332ef012b37aa0caf38ae4bdb72ba56d131e2b Mon Sep 17 00:00:00 2001 From: visnyei Date: Fri, 15 Jun 2018 10:51:46 +0200 Subject: [PATCH] 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 --- doc/source/code-and-documentation/index.rst | 1 + .../code-and-documentation/introduction.rst | 4 ++++ .../references-doc-contrib-guide.rst | 15 +++++++++++++++ 3 files changed, 20 insertions(+) create mode 100644 doc/source/code-and-documentation/references-doc-contrib-guide.rst diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index ece1700..578b363 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -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 diff --git a/doc/source/code-and-documentation/introduction.rst b/doc/source/code-and-documentation/introduction.rst index 934d330..0a1a165 100644 --- a/doc/source/code-and-documentation/introduction.rst +++ b/doc/source/code-and-documentation/introduction.rst @@ -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 `_. diff --git a/doc/source/code-and-documentation/references-doc-contrib-guide.rst b/doc/source/code-and-documentation/references-doc-contrib-guide.rst new file mode 100644 index 0000000..e2f96d5 --- /dev/null +++ b/doc/source/code-and-documentation/references-doc-contrib-guide.rst @@ -0,0 +1,15 @@ +######################################### +OpenStack Documentation Contributor Guide +######################################### + +The `OpenStack Documentation Contributor Guide +`_ describes how to +contribute to OpenStack documentation. It contains information on +`writing +`_, +`building +`_, and +`reviewing +`_ documents, +as well as best practices and `API documentation guidelines +`_`.