<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, May 14, 2015 at 3:52 AM, John Garbutt <span dir="ltr"><<a href="mailto:john@johngarbutt.com" target="_blank">john@johngarbutt.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 May 2015 at 20:33, Sean Dague <<a href="mailto:sean@dague.net">sean@dague.net</a>> wrote:<br>
> On 05/12/2015 01:12 PM, Jeremy Stanley wrote:<br>
>> On 2015-05-12 10:04:11 -0700 (-0700), Clint Byrum wrote:<br>
>>> It's a nice up side. However, as others have pointed out, it's only<br>
>>> capable of displaying the most basic pieces of the architecture.<br>
>>><br>
>>> For higher level views with more components, I don't think ASCII art<br>
>>> can provide enough bandwidth to help as much as a vector diagram.<br>
>><br>
>> Of course, simply a reminder that just because you have one or two<br>
>> complex diagram callouts in a document doesn't mean it's necessary<br>
>> to also go back and replace your simpler ASCII art diagrams with<br>
>> unintelligible (without rendering) SVG or Postscript or whatever.<br>
>> Doing so pointlessly alienates at least some fraction of readers.<br>
><br>
> Sure, it's all about trade offs.<br>
><br>
> But I believe that statement implicitly assumes that ascii art diagrams<br>
> do not alienate some fraction of readers. And I think that's a bad<br>
> assumption.<br>
><br>
> If we all feel alienated every time anyone does anything that's not<br>
> exactly the way we would have done it, it's time to give up and pack it<br>
> in. :) This thread specifically mentioned source based image formats<br>
> that were internationally adopted open standards (w3c SVG, ISO ODG) that<br>
> have free software editors that exist in Windows, Mac, and Linux<br>
> (Inkscape and Open/LibreOffice).<br>
<br>
</span>Some great points make here.<br>
<br>
Lets try decide something, and move forward here.<br>
<br>
Key requirements seem to be:<br>
* we need something that gives us readable diagrams<br>
* if its not easy to edit, it will go stale<br>
* ideally needs to be source based, so it lives happily inside git<br>
* needs to integrate into our sphinx pipeline<br>
* ideally have an opensource editor for that format (import and<br>
export), for most platforms<br>
<br>
ascii art fails on many of these, but its always a trade off.<br>
<br>
Possible way forward:<br>
* lets avoid merging large hard to edit bitmap style images<br>
* nova-core reviewers can apply their judgement on merging source based formats<br>
* however it *must* render correctly in the generated html (see result<br>
of docs CI job)<br>
<br>
Trying out SVG, and possibly blockdiag, seem like the front runners.<br>
I don't think we will get consensus without trying them, so lets do that.<br>
<br>
Will that approach work?<br>
<br></blockquote><div><br></div><div>Sounds like a great plan.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Thanks,<br>
John<br>
<div class="HOEnZb"><div class="h5"><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>
</div></div></blockquote></div><br></div></div>