<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Tue, May 12, 2015 at 8:22 AM, Steve Baker <span dir="ltr"><<a href="mailto:sbaker@redhat.com" target="_blank">sbaker@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On 12/05/15 09:57, Joe Gordon wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
When learning about how a project works one of the first things I look for is a brief architecture description along with a diagram. For most OpenStack projects, all I can find is a bunch of random third party slides and diagrams.<br>
<br>
Most Individual OpenStack projects have either no architecture diagram or ascii art. Searching for 'OpenStack X architecture' where X is any of the OpenStack projects turns up pretty sad results. For example heat [0] an Keystone [1] have no diagram. Nova on the other hand does have a diagram, but its ascii art [2]. I don't think ascii art makes for great user facing documentation (for any kind of user).<br>
<br>
So how can we do better then ascii art architecture diagrams?<br>
<br>
</blockquote></span>
How about ascii source diagrams?<span class=""><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
[0] <a href="http://docs.openstack.org/developer/heat/architecture.html" target="_blank">http://docs.openstack.org/developer/heat/architecture.html</a><br>
[1] <a href="http://docs.openstack.org/developer/keystone/architecture.html" target="_blank">http://docs.openstack.org/developer/keystone/architecture.html</a><br>
[2] <a href="http://docs.openstack.org/developer/nova/devref/architecture.html" target="_blank">http://docs.openstack.org/developer/nova/devref/architecture.html</a><br>
<br>
</blockquote>
<br></span>
These are all sphinx generated documents, so we could use something like blockdiag to generate all manner of diagrams<br>
<a href="https://pypi.python.org/pypi/sphinxcontrib-blockdiag" target="_blank">https://pypi.python.org/pypi/sphinxcontrib-blockdiag</a><br>
<a href="http://blockdiag.com/en/" target="_blank">http://blockdiag.com/en/</a></blockquote><div><br></div><div>+1 maybe we can trial it in Heat specs?</div><div><br></div><div>-Angus</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" target="_blank">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote></div><br></div></div>