<div dir="ltr"><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"><span style="font-size:12.8000001907349px">Couldn't we just use real image files to do this. IIRC, gerrit supports<br></span><span style="font-size:12.8000001907349px">displaying image files which are included in a commit. For example, I've been<br></span><span style="font-size:12.8000001907349px">planning to copy these images:</span></blockquote><div><br></div><div>+1 for real images</div><div><br></div><div>Best regards,</div><div>Boris Pavlovic </div></div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, May 12, 2015 at 1:36 AM, Matthew Treinish <span dir="ltr"><<a href="mailto:mtreinish@kortar.org" target="_blank">mtreinish@kortar.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">On Mon, May 11, 2015 at 02:57:48PM -0700, Joe Gordon wrote:<br>
> When learning about how a project works one of the first things I look for<br>
> is a brief architecture description along with a diagram. For most<br>
> OpenStack projects, all I can find is a bunch of random third party slides<br>
> and diagrams.<br>
><br>
> Most Individual OpenStack projects have either no architecture diagram or<br>
> ascii art. Searching for 'OpenStack X architecture' where X is any of the<br>
> OpenStack projects turns up pretty sad results. For example heat [0] an<br>
> Keystone [1] have no diagram. Nova on the other hand does have a diagram,<br>
> but its ascii art [2]. I don't think ascii art makes for great user facing<br>
> documentation (for any kind of user).<br>
><br>
> So how can we do better then ascii art architecture diagrams?<br>
><br>
> [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>
</div></div>Couldn't we just use real image files to do this. IIRC, gerrit supports<br>
displaying image files which are included in a commit. For example, I've been<br>
planning to copy these images:<br>
<br>
<a href="https://wiki.openstack.org/wiki/QA/AuthInterface" target="_blank">https://wiki.openstack.org/wiki/QA/AuthInterface</a><br>
<br>
into the tempest docs for some time. They just need to be updated a bit to<br>
reflect some recent changes.<br>
<br>
The only downside I see is that it makes editing more difficult, I guess that's<br>
really the tradeoff.<br>
<br>
-Matt Treinish<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>
<br></blockquote></div><br></div>