Open Stack

Hi everyone,

The documentation team has been having issues with bugs being filed asking for troubleshooting and support for years. We have been doing our best to redirect and close, but it is becoming increasingly unmanageable.

I know other projects struggle with this issue too. We implemented a (hopeful) solution and if anyone is interested, here’s what we did:


1.       Using ‘Configure bug tracker’ within Launchpad, we updated the ‘Helpful guidelines for reporting a bug’ with information about where to go if you have a troubleshooting or support question. You can view the checklist here: https://bugs.launchpad.net/openstack-manuals/+configure-bugtracker or here: https://bugs.launchpad.net/openstack-manuals/+filebug



2.       Using the openstackdocstheme we implemented a checklist. When a reporter goes to report a bug using the ‘Report a Bug’ bug button in the guides (on the right hand side), the “Further information” section will now produce a checklist.
This checklist states the following:


This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:



- [ ] This doc is inaccurate in this way: ______

- [ ] This is a doc addition request.

- [ ] I have a fix to the document that I can paste below including example: input and output.



If you have a troubleshooting or support issue, use the following resources:



- Ask OpenStack: http://ask.openstack.org

- The mailing list: http://lists.openstack.org

- IRC: 'openstack' channel on Freenode

You can see the checklist in action here: https://bugs.launchpad.net/openstack-manuals/+bug/1658965

This was our solution to the problem – hopefully this helps some others with implementing their own ☺

If you have any questions, feel free to reach out ☺

Thanks,

Alex

IRC: asettle
Twitter: dewsday




-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20170124/739d84e2/attachment.html>