<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><meta http-equiv=Content-Type content="text/html; charset=utf-8"><meta name=Generator content="Microsoft Word 15 (filtered medium)"><style><!--
/* Font Definitions */
@font-face
{font-family:"ＭＳ 明朝";
panose-1:2 2 6 9 4 2 5 8 3 4;}
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:"Trebuchet MS";
panose-1:2 11 6 3 2 2 2 2 2 4;}
@font-face
{font-family:"\@ＭＳ 明朝";
panose-1:2 2 6 9 4 2 5 8 3 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman",serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-reply;
font-family:"Trebuchet MS",sans-serif;
color:#002060;}
span.pl-s1
{mso-style-name:pl-s1;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri",sans-serif;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:99.25pt 3.0cm 3.0cm 3.0cm;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]--></head><body lang=EN-US link=blue vlink=purple><div class=WordSection1><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'>Anne,<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'>a first attempt at a partial fix is now in the system https://review.openstack.org/#/c/160151/. Regarding the readthedocs breadcrumb implementation, the question is: Where does information like this come from:<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><span class=pl-s1>{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}</span><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'>Is there a process that, for example, populates conf.py with github_user and so on? For a meaningful bug report in our context, it would have to be information like name of the source file, URL of the finished HTML etc.<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'>If anybody else on the distribution list has an idea, don’t hold back!<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.0pt;font-family:"Calibri",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><span style='font-size:10.0pt;font-family:"Calibri",sans-serif;color:#002060'>Bernd Bausch<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.0pt;font-family:"Calibri",sans-serif;color:#002060'><a href="mailto:berndbausch@gmail.com"><span style='color:#0563C1'>berndbausch@gmail.com</span></a><o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.0pt;font-family:"Calibri",sans-serif;color:#002060'>+81 80 8892 5564<o:p></o:p></span></p><p class=MsoNormal><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#002060'><o:p> </o:p></span></p><p class=MsoNormal><b><span style='font-size:11.0pt;font-family:"Calibri",sans-serif'>From:</span></b><span style='font-size:11.0pt;font-family:"Calibri",sans-serif'> Anne Gentle [mailto:annegentle@justwriteclick.com] <br><b>Sent:</b> 2015</span><span style='font-size:11.0pt;font-family:"ＭＳ 明朝",serif'>年</span><span style='font-size:11.0pt;font-family:"Calibri",sans-serif'>2</span><span style='font-size:11.0pt;font-family:"ＭＳ 明朝",serif'>月</span><span style='font-size:11.0pt;font-family:"Calibri",sans-serif'>28</span><span style='font-size:11.0pt;font-family:"ＭＳ 明朝",serif'>日</span><span style='font-size:11.0pt;font-family:"Calibri",sans-serif'> 0:51<br><b>To:</b> Bernd Bausch<br><b>Cc:</b> openstack-docs@lists.openstack.org<br><b>Subject:</b> Re: [OpenStack-docs] Adding "Log a doc bug" link to openstackdocstheme<o:p></o:p></span></p><p class=MsoNormal><o:p> </o:p></p><div><p class=MsoNormal>Hi Bernd! Great questions.<o:p></o:p></p><div><p class=MsoNormal><o:p> </o:p></p><div><p class=MsoNormal>On Thu, Feb 26, 2015 at 3:06 AM, Bernd Bausch <<a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a>> wrote:<o:p></o:p></p><blockquote style='border:none;border-left:solid #CCCCCC 1.0pt;padding:0cm 0cm 0cm 6.0pt;margin-left:4.8pt;margin-right:0cm'><div><div><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>First, I hope it’s OK if a newbie uses this mailing list to request help for bug fixing. If there are better ways, please let me know.</span><o:p></o:p></p></div></div></blockquote><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>Absolutely use this list! <o:p></o:p></p></div><div><p class=MsoNormal> <o:p></o:p></p></div><blockquote style='border:none;border-left:solid #CCCCCC 1.0pt;padding:0cm 0cm 0cm 6.0pt;margin-left:4.8pt;margin-right:0cm'><div><div><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>The bug in question is <a href="https://bugs.launchpad.net/openstack-manuals/+bug/1421799" target="_blank">https://bugs.launchpad.net/openstack-manuals/+bug/1421799</a>. It’s a request to add a “log a bug” link to the openstackdocstheme templates, similar to the cute red bug links at the top and bottom of each page in the current DocBook-based documentation.</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>I recklessly assigned this bug to myself. While I should be able to put the mechanism in place, I don’t have enough information to construct the link into launchpad and could do with some help from knowledgeable people.</span><o:p></o:p></p></div></div></blockquote><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>Hehe on recklessly. :) <o:p></o:p></p></div><div><p class=MsoNormal> <o:p></o:p></p></div><blockquote style='border:none;border-left:solid #CCCCCC 1.0pt;padding:0cm 0cm 0cm 6.0pt;margin-left:4.8pt;margin-right:0cm'><div><div><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>In the current documentation, the bug link is a launchpad URL that contains the book title (such as “SLES 11 installation guide”) and information of the following form:</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;margin-left:36.0pt'>-----------------------------------<br>Built: 2015-02-17T17:45:22 00:00<br>git SHA: 3f5dd2abd6d6f94cfffcb26f88c830da38af5d9e<br>URL: <a href="http://docs.openstack.org/juno/config-reference/content/section_compute-scheduler.html" target="_blank">http://docs.openstack.org/juno/config-reference/content/section_compute-scheduler.html</a><br>source File: file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/config-reference/compute/section_compute-scheduler.xml<br>xml:id: section_compute-scheduler<o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>My question is: Where would I find equivalent information in the Sphinx/Jinja environment? </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>The Sphinx documentation lists a few promising helper functions and variables (<a href="http://sphinx-doc.org/templating.html#helper-functions" target="_blank">http://sphinx-doc.org/templating.html#helper-functions</a>). It seems that some settings are derived from conf.py, and I don’t know if there is any conf.py standard that I can base this on.</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>No idea how to retrieve the SHA key, and what to use instead of the XML ID (or can it just be left out).</span><o:p></o:p></p></div></div></blockquote><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>Those helper-functions don't have what we need, but they can be a model to make what we need, and then inserted into our theme, openstackdocstheme.<o:p></o:p></p></div><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>Tom's got the basic idea of what we need, and the next step is to figure out how to create our own helper function for our launchpad bug link creation. I might be totally wrong here, but think we'll need an HTML template like what Read the Docs does to make their breadcrumbs:<o:p></o:p></p></div><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal><a href="https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html" target="_blank">https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html</a><o:p></o:p></p></div><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>What I'd have to look at with you, and I'm happy to do so, is where to put this in our theme. Probably in the html templates. Then next figure out how to make that html template be output in the place where the little bug icon goes on every page.<o:p></o:p></p></div><div><p class=MsoNormal> <o:p></o:p></p></div><blockquote style='border:none;border-left:solid #CCCCCC 1.0pt;padding:0cm 0cm 0cm 6.0pt;margin-left:4.8pt;margin-right:0cm'><div><div><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>Rather than asking for help, I could also just implement whatever I can and leave a few gaps for more experienced people or reviewers. Is that an acceptable approach?</span><o:p></o:p></p></div></div></blockquote><div><p class=MsoNormal><o:p> </o:p></p></div><div><p class=MsoNormal>I'd be happy to collaborate with you on a patch, then you can also get used to the gerrit/git review ways of patching patches. So feel free to upload anything, even if you just want to practice patching, and then reach out to me on the list so I can take a look. Should be fun!<o:p></o:p></p></div><div><p class=MsoNormal>Anne<o:p></o:p></p></div><div><p class=MsoNormal> <o:p></o:p></p></div><blockquote style='border:none;border-left:solid #CCCCCC 1.0pt;padding:0cm 0cm 0cm 6.0pt;margin-left:4.8pt;margin-right:0cm'><div><div><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>Regards,</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'> </span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.5pt;font-family:"Trebuchet MS",sans-serif;color:#240692'>Bernd</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.0pt;color:#240692'>Bernd Bausch</span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.0pt;color:#240692'><a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a></span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'><span style='font-size:10.0pt;color:#240692'><a href="tel:%2B81%2080%208892%205564" target="_blank">+81 80 8892 5564</a></span><o:p></o:p></p><p class=MsoNormal style='mso-margin-top-alt:auto;mso-margin-bottom-alt:auto'> <o:p></o:p></p></div></div><p class=MsoNormal style='margin-bottom:12.0pt'><br>_______________________________________________<br>OpenStack-docs mailing list<br><a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><o:p></o:p></p></blockquote></div><p class=MsoNormal><br><br clear=all><o:p></o:p></p><div><p class=MsoNormal><o:p> </o:p></p></div><p class=MsoNormal>-- <o:p></o:p></p><div><p class=MsoNormal>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a><o:p></o:p></p></div></div></div></div></body></html>