Improve the Operations Guide

Improve the Operations Guide

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

Reorganize and update the Operations Guide.

Problem description

The Operations Guide has become outdated over time, with identified gaps in content.

Proposed change

Based on doc sessions at the Mitaka summit, reorganize and update the guide to improve usability and accessibility of information.

Alternatives

Leave the guide as it is.

Implementation

Assignee(s)

Primary assignee:

  • shilla-saebi

Other contributors:

  • Ops Guide specialty team

Work Items

  • Reach a consensus on the information architecture
  • Rework the abstract to clearly identify the audience and purpose of the book
  • Move content to improve information architecture
  • Identify information gaps and submit and fix bugs

Dependencies

This work is dependent on the guide being converted from DocBook to RST. See Operations Guide: RST conversion.

Testing

Testing will follow the standard documentation review process.

References

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.

docs-specs 0.0.1.dev186