← Back to team overview

openstack-doc-core team mailing list archive

Troubleshooting docs: in one chapter or across multiple chapters?

 

(crossposting to doc-core in case not everyone there has moved over to openstack-docs yet).

A question came up on this merge proposal: https://review.openstack.org/9494

In that proposal, I had created a "troubleshooting" section in the Networking chapter in the Compute Admin guide. Tom pointed out that we already have a whole Troubleshooting chapter and asked whether it made sense to just keep it in one place or split it across sections. I wanted to bring it up to the list to see what people thought.

I liked having it by section to have the Networking troubleshooting docs closer to the rest of the networking content. But I can imagine troubleshooting issues where it would deal with issues across multiple sections (e.g., some interaction between scheduling and VMs, for example), in which case that would make it harder to find the right content, since a reader might miss the troubleshooting section that solves their problem.

Also, right now the OpenStack Compute Troubleshooting chapter is pretty anemic <http://docs.openstack.org/essex/openstack-compute/admin/content/common-errors-and-fixes-for-openstack-compute.html>. Whatever we do, we should probably start populating that with fixes to common issues in better detail.

Take care,

Lorin
--
Lorin Hochstein
Lead Architect - Cloud Services
Nimbis Services, Inc.
www.nimbisservices.com






Follow ups