From 5990fd26e95173893fa05b1dac42694a685aba6d Mon Sep 17 00:00:00 2001 From: OlgaGusarenko Date: Thu, 22 Oct 2015 13:17:25 +0300 Subject: [PATCH] [Contributor Guide] DocBook conventions Links users to the wiki page where the DocBook conventions are stored with some intro. Change-Id: I3e7f442554171ab0bb5ccbb600b6406a24303600 --- doc/contributor-guide/source/docbook-conv.rst | 29 +++++++++++++++++++ doc/contributor-guide/source/index.rst | 1 + 2 files changed, 30 insertions(+) create mode 100644 doc/contributor-guide/source/docbook-conv.rst diff --git a/doc/contributor-guide/source/docbook-conv.rst b/doc/contributor-guide/source/docbook-conv.rst new file mode 100644 index 0000000000..a50f308336 --- /dev/null +++ b/doc/contributor-guide/source/docbook-conv.rst @@ -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 + diff --git a/doc/contributor-guide/source/index.rst b/doc/contributor-guide/source/index.rst index b26ed51012..725bd5eac1 100644 --- a/doc/contributor-guide/source/index.rst +++ b/doc/contributor-guide/source/index.rst @@ -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