[Contributor Guide] DocBook conventions
Links users to the wiki page where the DocBook conventions are stored with some intro. Change-Id: I3e7f442554171ab0bb5ccbb600b6406a24303600
This commit is contained in:
parent
844140608a
commit
5990fd26e9
29
doc/contributor-guide/source/docbook-conv.rst
Normal file
29
doc/contributor-guide/source/docbook-conv.rst
Normal file
@ -0,0 +1,29 @@
|
||||
.. _docbook-conv:
|
||||
|
||||
==============================
|
||||
DocBook formatting conventions
|
||||
==============================
|
||||
|
||||
OpenStack documentation uses either DocBook or ReStructured Text (RST)
|
||||
syntax.
|
||||
|
||||
For the DocBook formatting conventions, refer to the
|
||||
`Documentation/Markup conventions`_ page.
|
||||
|
||||
Currently the Documentation team is working on the conversion
|
||||
from DocBook to ReStructured Text (RST). For more information
|
||||
on the conversion, see the `Documentation/Migrate`_ page.
|
||||
|
||||
The guides to be converted for the Mitaka release are:
|
||||
|
||||
* `Architecture guide`_
|
||||
* `Operations guide`_
|
||||
|
||||
|
||||
.. Links
|
||||
|
||||
.. _`Documentation/Markup conventions`: https://wiki.openstack.org/wiki/Documentation/Markup_conventions
|
||||
.. _`Documentation/Migrate`: https://wiki.openstack.org/wiki/Documentation/Migrate
|
||||
.. _`Architecture guide`: http://specs.openstack.org/openstack/docs-specs/specs/mitaka/archguide-mitaka-rst.html#architecture-design-guide-rst-conversion
|
||||
.. _`Operations guide`: http://specs.openstack.org/openstack/docs-specs/specs/mitaka/ops-guide-rst.html
|
||||
|
@ -18,6 +18,7 @@ Contents
|
||||
introduction.rst
|
||||
first-timers-quickstart.rst
|
||||
rst-conv.rst
|
||||
docbook-conv.rst
|
||||
docs-structure.rst
|
||||
content-specs.rst
|
||||
docs_builds.rst
|
||||
|
Loading…
Reference in New Issue
Block a user