openstack/openstackdocstheme
Code Issues Proposed changes

Includes checklist when filing a bug for osmanuals

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

Change-Id: I88222caca2b653dffe5b42587a918737ce358fba
This commit is contained in:
Alexandra Settle 2017-01-19 13:04:22 +00:00 committed by Anne Gentle
parent 014d38fa36
commit 58823b338c
2 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
openstackdocstheme/theme/openstackdocs/static/js/docs.js
View File

@ -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 // Launchpad with pre-filled information such as git SHA, git.openstack.org
// source URL, published document URL and tag. // source URL, published document URL and tag.
function logABug(bugTitle, bugProject, fieldComment, fieldTags) { function logABug(bugTitle, bugProject, fieldComment, fieldTags) {
var lineFeed = "%0A"; 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 currentURL = "URL: " + window.location.href;
var bugLink = urlBase + encodeURIComponent(bugTitle) + var bugLink = urlBase + encodeURIComponent(bugTitle) +
"&field.comment=" + lineFeed + lineFeed + "-----------------------------------" + lineFeed + fieldComment + "&field.comment=" + lineFeed + lineFeed + lineFeed +
bugChecklist + lineFeed + "-----------------------------------" + lineFeed + fieldComment +
lineFeed + currentURL + lineFeed + currentURL +
"&field.tags=" + fieldTags; "&field.tags=" + fieldTags;
document.getElementById("logABugLink1").href=bugLink; document.getElementById("logABugLink1").href=bugLink;

8
releasenotes/notes/doc-bug-template-7234e7f00e0ff599.yaml Normal file
View File

@ -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.