<div dir="ltr">Hi Bernd! Great questions.<br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Feb 26, 2015 at 3:06 AM, Bernd Bausch <span dir="ltr"><<a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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></p></div></div></blockquote><div><br></div><div>Absolutely use this list! </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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.<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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></p></div></div></blockquote><div><br></div><div>Hehe on recklessly. :) </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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:<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal" style="margin-left:36pt">-----------------------------------<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<span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">My question is: Where would I find equivalent information in the Sphinx/Jinja environment? <u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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.<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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></p></div></div></blockquote><div><br></div><div>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.</div><div><br></div><div>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:</div><div><br></div><div><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></div><div><br></div><div>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.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">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></p></div></div></blockquote><div><br></div><div>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!</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="#0563C1" vlink="#954F72"><div><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">Regards,<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)"><u></u> <u></u></span></p><p class="MsoNormal"><span style="font-size:10.5pt;font-family:'Trebuchet MS',sans-serif;color:rgb(36,6,146)">Bernd</span><span style="font-size:10pt;color:rgb(36,6,146)"><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10pt;color:rgb(36,6,146)">Bernd Bausch<u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10pt;color:rgb(36,6,146)"><a href="mailto:berndbausch@gmail.com" target="_blank">berndbausch@gmail.com</a><u></u><u></u></span></p><p class="MsoNormal"><span style="font-size:10pt;color:rgb(36,6,146)"><a href="tel:%2B81%2080%208892%205564" value="+818088925564" target="_blank">+81 80 8892 5564</a><u></u><u></u></span></p><p class="MsoNormal"><u></u> <u></u></p></div></div><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><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div></div>