5990fd26e9
Links users to the wiki page where the DocBook conventions are stored with some intro. Change-Id: I3e7f442554171ab0bb5ccbb600b6406a24303600
30 lines
1.0 KiB
ReStructuredText
30 lines
1.0 KiB
ReStructuredText
.. _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
|
|
|