docs-specs/specs/mitaka/ops-guide-rst.rst

2.1 KiB

Operations Guide: RST conversion

https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst

Convert the Operations Guide from DocBook to RST.

Problem description

The Operations Guide will be converted from DocBook to RST for the Mitaka release. This conversion is a precursor to reorganising the guide.

Proposed change

Convert the Operations Guide to RST.

Alternatives

None

Implementation

Assignee(s)

Primary assignee:

  • dazzachan

Other contributors:

  • shilla-saebi
  • alexandra-settle
  • kato-tomoyuki

Work Items

  • Convert content from DocBook to RST
  • Ensure bug fix proposals are included in DocBook and RST during the conversion process.
  • Track changes in wiki.
  • Update our build infrastructure so that Sphinx is used for publishing the Operations Guide.
  • Apply the openstackdocstheme template to the guide.
  • Import translations from the old guide to the new guide.

Dependencies

The main dependency is on docs.openstack.org infrastructure updates.

Testing

  • Test the new HTML design on the following browsers/operating systems:
    • Chrome on Ubuntu, Fedora, Mac, Windows
    • Firefox on Ubuntu, Fedora, Mac, Windows

References