[Openstack-docs] [Openstack-doc-core] Troubleshooting docs: in one chapter or across multiple chapters?

Razique Mahroua razique.mahroua at gmail.com
Tue Jul 17 08:15:37 UTC 2012


Hi, 
I thought in the first place it would make sense to gather all the troubleshooting in the same place, but it turns out that when you are working on a specific operations around networking, referring to the documentation, it makes sense to me to have the troubleshooting around.
Also for the docs writers, knowing the net. troubleshooting is just under would likely to help producing the content for that part I think.


Razique
Nuage & Co - Razique Mahroua 
razique.mahroua at gmail.com



Le 12 juil. 2012 à 19:58, Tom Fifield a écrit :

> For reference, I'm fine with either, provided it's thought through or even better ... consistent :)
> 
> Assisting troubleshooting is an important role, and an "anemic" chapter is a sad, sad thing :)
> 
> Of course, with our excellent re-use-loving structuring of chapters, it should be possible to even do both if needed or swap in the future ...
> 
> Regards,
> 
> Tom
> 
> (this email is sent at 4am local time, and may contain Australian lingo or not make sense)
> 
> On 13/07/12 01:08, Anne Gentle wrote:
>> I like troubleshooting info very close to the topic it addresses. It's
>> also good to pull common errors into one place.
>> 
>> Anne Gentle
>> Content Stacker
>> anne at openstack.org <mailto:anne at openstack.org>
>> 
>> 
>> On Jul 12, 2012, at 9:45 AM, Lorin Hochstein <lorin at nimbisservices.com
>> <mailto:lorin at nimbisservices.com>> wrote:
>> 
>>> (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 <https://www.nimbisservices.com/>
>>> 
>>> 
>>> 
>>> 
>>> 
>>> --
>>> Mailing list: https://launchpad.net/~openstack-doc-core
>>> Post to     : openstack-doc-core at lists.launchpad.net
>>> <mailto:openstack-doc-core at lists.launchpad.net>
>>> Unsubscribe : https://launchpad.net/~openstack-doc-core
>>> More help   : https://help.launchpad.net/ListHelp
>> 
>> 
> 
> 
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20120717/b055e0a4/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: NUAGECO-LOGO-Fblan_petit.jpg
Type: image/jpeg
Size: 10122 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20120717/b055e0a4/attachment-0001.jpg>


More information about the Openstack-docs mailing list