<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Oct 2, 2014 at 1:52 PM, Vikram Hosakote (vhosakot) <span dir="ltr"><<a href="mailto:vhosakot@cisco.com" target="_blank">vhosakot@cisco.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 style="word-wrap:break-word;color:rgb(0,0,0);font-size:15px;font-family:Calibri,sans-serif">
<div>Hi Anne,</div>
<div><br>
</div>
<div>Thanks a lot for the reply. Sure, I will attend tomorrow’s bootstrapping session on dev docs at 3:00 EST and ask this question on Etherpad.</div>
<div><br>
</div>
<div>Stefano,</div>
<div><br>
</div>
<div>Can you please let me know if I can submit a draft blueprint for the integration of doxygen into OpenStack ? If yes, in which project ? (openstack-manuals ?, tempest ?, openstack-ci ? openstack-sdk ?)</div><span class="">
<div><br></div></span></div></blockquote><div><br></div><div>I'd like you to consider it a spec for cross-project since its implementation should affect all project's developers. There's a conversation going on now about that on the openstack-dev list, follow along here: </div><div><br></div><div><a href="http://lists.openstack.org/pipermail/openstack-dev/2014-October/047600.html">http://lists.openstack.org/pipermail/openstack-dev/2014-October/047600.html</a><br></div><div><br></div><div>It's looking like it'll be reviewed by the TC overall. </div><div><br></div><div>Let me know if that makes sense -- and Stef, let me know if that makes sense to you.</div><div><br></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 style="word-wrap:break-word;color:rgb(0,0,0);font-size:15px;font-family:Calibri,sans-serif"><span class=""><div>
</div>
<div>Thanks a lot!</div>
<div><br>
</div>
<div>Regards,</div>
<div>
<div>Vikram Hosakote</div>
<div>OpenStack Software Engineer | <a href="mailto:vhosakot@cisco.com" target="_blank">vhosakot@cisco.com</a></div>
<div>Cloud and Virtualization Group | Cisco Systems</div>
<div>Boxborough MA | Work : <a href="tel:978-936-8799" value="+19789368799" target="_blank">978-936-8799</a></div>
</div>
<div><br>
</div>
</span><span>
<div style="font-family:Calibri;font-size:11pt;text-align:left;color:black;border-width:1pt medium medium;border-style:solid none none;padding:3pt 0in 0in;border-top-color:rgb(181,196,223)">
<span style="font-weight:bold">From: </span>Anne Gentle <<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>><br>
<span style="font-weight:bold">Date: </span>Wednesday, October 1, 2014 at 9:18 PM<br>
<span style="font-weight:bold">To: </span>"<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>" <<a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a>>, Vikram Hosakote <<a href="mailto:vhosakot@cisco.com" target="_blank">vhosakot@cisco.com</a>>,
Stefano Maffulli <<a href="mailto:stefano@openstack.org" target="_blank">stefano@openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>doxygen<br>
</div><div><div class="h5">
<div><br>
</div>
<div>
<div>
<div dir="ltr">Replying here on <a href="mailto:openstack-docs@lists.openstack.org" target="_blank">
openstack-docs@lists.openstack.org</a> from a note (pasted below) that was sent to the docs-core list on Launchpad. We don't really use Launchpad mailing lists for communication, sorry about that.
<br>
<br>
---<br>
<br>
Hi OpenStack documentation team, <br>
<br>
Today’s OpenStack does not have doxygen integrated. I found no blueprints about integrating doxygen into OpenStack manuals.<br>
<br>
Integrating doxygen will be very helpful for API users to understand the documentation, flow, call-graphs, classes, namespaces, files, functions, attributes (public / static), data structures, dependencies, etc in a pictorial way using a web browser. Once doxygen
is integrated, all the code can be understood easily and fast in a web browser instead of manually figuring out in the code repository.<br>
<br>
If new code, files, modules are added, there must a script that runs (as part of tempest, tox, or testr) doxygen and updates all the HTML files.<br>
<br>
Please let me know if I can submit a draft blueprint for this request under the "openstack-manuals” project.<br>
<br>
Please let me know your thoughts. Thanks a lot!<br>
<br>
Regards, Vikram Hosakote OpenStack Software Engineer | <a href="mailto:vhosakot@cisco.com" target="_blank">
vhosakot@cisco.com</a> Cloud and Virtualization Group | Cisco Systems Boxborough MA | Work : <a href="tel:978-936-8799" value="+19789368799" target="_blank">978-936-8799</a><br>
<br>
<br>
---<br>
<br>
Thanks for asking. We definitely appreciate automation. Our primary focus for the official docs Program is end user (including app dev) and operator/admin docs right now.
<br>
<br>
Python docs for contributor devs is not really governed in the openstack-manuals blueprint area, but I know that Stefano Maffuli, our OpenStack community manager, is interested in improving contributor dev docs. Also I don't quite know how Doxygen would help
API users (though perhaps you mean the internal APIs where of course it would help).
<br>
<br>
Stefano, can you think of a good place for this type of blueprint to land? Or team, do you envision a need to expand the doc program's scope to include this type of dev doc?<br>
<br>
Be sure to come to the bootstrapping session this Friday 10/3 at 3:00 EST where we'll discuss dev docs.
<a href="https://wiki.openstack.org/wiki/BootstrappingHour/Diving_Into_Docs" target="_blank">https://wiki.openstack.org/wiki/BootstrappingHour/Diving_Into_Docs</a><br>
Thanks,<br>
Anne<br>
</div>
</div>
</div>
</div></div></span>
</div>
</blockquote></div><br></div></div>