7c34ce5d69
Reorganised to add quickstart info for developers and new big tent projects. Change-Id: I698a49ff1628349d372f91136b2829be5f8c2ebc Closes-Bug: #1553873 Depends-On: I72a7d57ae49ed2123475d3d1051c630e7b69dcaf
44 lines
932 B
ReStructuredText
44 lines
932 B
ReStructuredText
=========================================
|
|
OpenStack Documentation Contributor Guide
|
|
=========================================
|
|
|
|
Abstract
|
|
~~~~~~~~
|
|
|
|
This guide provides detailed instructions on the documentation contribution
|
|
workflow and conventions to be considered by all contributors. Please
|
|
follow these guidelines to keep the documentation structure, style, and
|
|
syntax consistent.
|
|
|
|
Contents
|
|
~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
quickstart.rst
|
|
additional-git-workflow.rst
|
|
writing-style.rst
|
|
topic-structure.rst
|
|
topic-tags.rst
|
|
rst-conv.rst
|
|
docbook-conv.rst
|
|
docs-structure.rst
|
|
team-structure.rst
|
|
content-specs.rst
|
|
tools-and-content-overview.rst
|
|
doc-bugs.rst
|
|
docs-review.rst
|
|
docs-builds.rst
|
|
build-locally.rst
|
|
blueprints-and-specs.rst
|
|
json-conventions.rst
|
|
ui-text-guidelines.rst
|
|
doc-tools.rst
|
|
common/glossary.rst
|
|
|
|
Search in this guide
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* :ref:`search`
|