Architecture Design Guide: RST conversion

updated: 2018-12-06 13:55

Architecture Design Guide: RST conversion

https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst

Convert the Architecture Design Guide from DocBook to RST.

Problem description

The Architecture Design 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 Architecture Design Guide to RST.

Alternatives

None

Implementation

Assignee(s)

Primary assignee:

  • shilla-saebi

Other contributors:

  • dazzachan
  • alexandra-settle
  • kato-tomoyuki
  • berendt

Work Items

  • 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 Architecture Design Guide.
  • Apply the openstackdocstheme template to the 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

  • Discussion can occur using any official medium including IRC in #openstack-doc, the openstack-docs mailing list with [arch-guide] in the subject, weekly Ops Guide specialty team meeting, weekly documentation team meeting, and potentially etherpads.
updated: 2018-12-06 13:55
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

questions?

docs-specs