During the Ops Midcycle, documentation was discussed as a primary concern for operators. Specifically, operators expressed concerns with documentation updates, and specific content for example deployments and architectures. For example, the web applications workload reference architecture.[1]
This proposal is aimed at gathering those interested in operations and documentation together to benefit the OpenStack Operations guide and the Administration Guide. The session will examine the following:
Provide a status update on the two guides
- Operations guide: Is this useful? Who uses it? Why?
- Administration guide: Is this useful? Who uses it? Why?
Discuss similarities between the guides, and where we can alleviate duplication
- Should operations focus on the theory of operating?
- Should administration focus on the actual operations of OpenStack
- Should we have one source of truth?
Discuss documentation team methods for updates
- How can this work with the operations community?
- Is there a better way to do this?
Get volunteers who will help see the update to completion
- Who can genuinely volunteer their time in Queens?
[1] https://www.openstack.org/assets/software/mitaka/OpenStack-WorkloadRefArchWebApps-v7.pdf
