<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Jan 18, 2017 at 8:55 AM, Alexandra Settle <span dir="ltr"><<a href="mailto:a.settle@outlook.com" target="_blank">a.settle@outlook.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">







<div bgcolor="white" lang="EN-US">
<div class="gmail-m_7340950390619006637WordSection1">
<p class="MsoNormal"><span style="font-size:11pt">Hi everyone,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Over the last week I’ve had a lot of time to go through and triage some of our ever-growing bug list.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">I know this is not a new issue, but we do have a considerably large number of bugs filed with troubleshooting issues and questions. Here is an example:
<a href="https://bugs.launchpad.net/openstack-manuals/+bug/1657464" target="_blank">https://bugs.launchpad.net/<wbr>openstack-manuals/+bug/1657464</a>
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">I have been doing my best to reply with either a solution to the problem, or a recommendation pointing the user to <a href="http://ask.openstack.org" target="_blank">ask.openstack.org</a>, IRC channels, or the mailing list.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> </span></p></div></div></blockquote><div><br></div><div>Thanks for doing that!</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div bgcolor="white" lang="EN-US"><div class="gmail-m_7340950390619006637WordSection1"><p class="MsoNormal"><span style="font-size:11pt"><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">I have proposed a small solution here:
<a href="https://review.openstack.org/#/c/421973/" target="_blank">https://review.openstack.org/#<wbr>/c/421973/</a> that will hopefully point some future bug reporters in the right direction, but it is not overly visible.</span></p></div></div></blockquote><div><br></div><div>So, adding to the contributor guide is a good idea, but let's also get it into the workflow and context of when the bug itself is logged.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div bgcolor="white" lang="EN-US"><div class="gmail-m_7340950390619006637WordSection1"><p class="MsoNormal"><span style="font-size:11pt"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">I am just thinking out loud – but when you go to report a bug here
<a href="https://bugs.launchpad.net/openstack-manuals/+filebug" target="_blank">https://bugs.launchpad.net/<wbr>openstack-manuals/+filebug</a> is there a way we could include a checklist of sorts? Including a few quick questions like “Does your bug relate to OpenStack manuals content”
 and then further offering appropriate places to ask questions like <a href="http://ask.openstack.org" target="_blank">ask.openstack.org</a>.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> </span></p></div></div></blockquote><div><br></div><div>Yep, we can add a template to the javascript that launches when the person clicks the bug icon, which is what happened in that bug 1657464. </div><div><br></div><div>Here's the code in the theme that you can change:</div><div><br></div><div><a href="https://github.com/openstack/openstackdocstheme/blob/master/openstackdocstheme/theme/openstackdocs/static/js/docs.js#L116-L130">https://github.com/openstack/openstackdocstheme/blob/master/openstackdocstheme/theme/openstackdocs/static/js/docs.js#L116-L130</a><br></div><div><br></div><div>While you only get ASCII text, I can imagine you could make a pretend checklist and also give guidance like so:</div><div><br></div><div>-------</div><div><br></div><div>Before you submit a doc bug, be sure to check these troubleshooting resources if you have a question. This form creates a doc bug, and you will get support quicker through these channels:<br>* Q&A site: <a href="http://ask.openstack.org">http://ask.openstack.org</a><br>* Mailing Lists: <a href="http://lists.openstack.org">http://lists.openstack.org</a> (Ask questions on the OpenStack mailing list or OpenStack-operators mailing list. Do not ask support questions on the OpenStack-dev mailing list.<br>* IRC: IRC channels are another way to ask questions, specifically the #openstack channel on Freenode. A list of all OpenStack IRC channels is here: <a href="https://wiki.openstack.org/wiki/IRC">https://wiki.openstack.org/wiki/IRC</a><br><br>If you do need to report a doc bug, feel free to use the following as a template and remove or add fields as you see fit. You can convert `[ ]` into `[x]` to check boxes.</div><div><div>--></div><div><br></div><div><br></div><div>- [ ] I believe this doc is inaccurate in this way: ______</div><div>- [ ] This is a doc addition request.</div><div>- [ ] I have a fix to the document that I can paste below including example input and output.</div></div><div><br></div><div><br></div><div>Feel free to write these up differently, but I think the point-of-entry is where we want this.</div><div><br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div bgcolor="white" lang="EN-US"><div class="gmail-m_7340950390619006637WordSection1"><p class="MsoNormal"><span style="font-size:11pt"><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">This problem does not just affect OpenStack manuals, and there was a rumour in the mill that we were going to change from Launchpad anyway.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">What does everyone think? Have we attempted this in the past? Is there a way we could actually help reporters before they file a bug that may never get solved?<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Thanks,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Alex<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
</div>
</div>

<br>______________________________<wbr>_________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.<wbr>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div dir="ltr"><div dir="ltr"><div><br></div><div>Read my blog: <a href="https://justwriteclick.com" target="_blank">justwrite.click</a></div><div>Subscribe to Docs|Code: <a href="http://docslikecode.com" target="_blank">docslikecode.com</a> </div></div></div></div></div></div></div>
</div></div>