From 58823b338cbeffeacce5b524269a5e6f194bbce9 Mon Sep 17 00:00:00 2001
From: Alexandra Settle <a.settle@outlook.com>
Date: Thu, 19 Jan 2017 13:04:22 +0000
Subject: [PATCH] Includes checklist when filing a bug for osmanuals

See the mailing list for more information:
http://lists.openstack.org/pipermail/openstack-docs/2017-January/009484.html

Change-Id: I88222caca2b653dffe5b42587a918737ce358fba
---
 .../theme/openstackdocs/static/js/docs.js     | 20 +++++++++++++++++--
 .../doc-bug-template-7234e7f00e0ff599.yaml    |  8 ++++++++
 2 files changed, 26 insertions(+), 2 deletions(-)
 create mode 100644 releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml

diff --git a/openstackdocstheme/theme/openstackdocs/static/js/docs.js b/openstackdocstheme/theme/openstackdocs/static/js/docs.js
index d8ad4f40..05d3b7dd 100644
--- a/openstackdocstheme/theme/openstackdocs/static/js/docs.js
+++ b/openstackdocstheme/theme/openstackdocs/static/js/docs.js
@@ -117,11 +117,27 @@ $('div.warning > p.admonition-title').prepend('<div class="fa fa-exclamation-tri
 // Launchpad with pre-filled information such as git SHA, git.openstack.org
 // source URL, published document URL and tag.
 function logABug(bugTitle, bugProject, fieldComment, fieldTags) {
+
     var lineFeed = "%0A";
-    var urlBase = "https://bugs.launchpad.net/" + bugProject + "/+filebug?field.title="
+
+    var bugChecklist = "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:" + lineFeed + lineFeed +
+        "- [ ] This doc is inaccurate in this way: ______" + lineFeed +
+        "- [ ] This is a doc addition request." + lineFeed +
+        "- [ ] I have a fix to the document that I can paste below including example: " +
+        "input and output. " + lineFeed + lineFeed +
+        "If you have a troubleshooting or support issue, use the following " +
+        " resources:" + lineFeed + lineFeed +
+        " - Ask OpenStack: http://ask.openstack.org" + lineFeed +
+        " - The mailing list: http://lists.openstack.org" + lineFeed +
+        " - IRC: 'openstack' channel on Freenode"+ lineFeed;
+
+    var urlBase = "https://bugs.launchpad.net/" + bugProject + "/+filebug?field.title=";
     var currentURL = "URL: " + window.location.href;
     var bugLink = urlBase  + encodeURIComponent(bugTitle) +
-        "&field.comment=" + lineFeed + lineFeed + "-----------------------------------" + lineFeed + fieldComment +
+        "&field.comment=" + lineFeed + lineFeed +  lineFeed +
+        bugChecklist + lineFeed + "-----------------------------------" + lineFeed + fieldComment +
         lineFeed + currentURL +
         "&field.tags=" + fieldTags;
     document.getElementById("logABugLink1").href=bugLink;
diff --git a/releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml b/releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml
new file mode 100644
index 00000000..3bdf3946
--- /dev/null
+++ b/releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml
@@ -0,0 +1,8 @@
+---
+features:
+  - Adds additional information to the doc bug template
+    used on Launchpad when a reader clicks the doc bug
+    icon to report a bug.
+other:
+  - Implemented intially to guide people to better ways
+    to get end-user support rather than log a doc bug.