diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index b467aa1..cdb8a05 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -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 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 +`_`.