<div dir="ltr">Hi Nate <div><br></div><div>Thanks for reaching out and starting the thread.<br><div><br></div><div><div>I have been doing a bit of research on options for an open diagramming, the following is a high level summary of what I have been looking at;</div><div><br></div><div>
<p class=""><b>Diagram Tools and Standards</b></p>
<p class=""><b>Rendering</b><br></p>
<ul class="">
<li class="">Diagrams should be rendered as PNG files, with the originals stored as SVG files. </li>
</ul>
<p class=""><b>Original Files</b></p>
<ul class="">
<li class="">Original files should be stored in the some structure as the image files.</li></ul>
<p class="">Requirements for tooling</p>
<ul class="">
<li class="">Support SVG as an output type</li>
<li class="">Support SVG as in a input file</li>
<li class="">Support PNG image export</li>
<li class="">Opensource </li>
<li class="">Free or minimal cost</li>
<li class="">Easy to use</li>
<li class="">Programatically create image</li></ul>
<p class=""><b>Online Tools</b></p>
<p class=""><b><span class=""> </span>Lucidchart </b><b>- </b><a href="https://www.lucidchart.com"><span class=""><b>https://www.lucidchart.com</b></span></a></p>
<p class=""><b><span class=""> </span>DrawSVG </b><b>- </b><a href="http://www.drawsvg.org/"><span class=""><b>http://www.drawsvg.org/</b></span></a></p>
<p class=""><br></p>
<p class=""><b>Installed Tools</b></p>
<p class=""><b><span class=""> </span>Inkscape </b><b>- </b><a href="https://inkscape.org/"><span class=""><b>https://inkscape.org/</b></span></a></p>
<p class=""><b><span class=""> </span>Omnigraffle </b><b>- </b><span class=""><b><a href="https://www.omnigroup.com/omnigraffle">https://www.omnigroup.com/omnigraffle</a></b></span></p></div><div><br></div><div>With regards to Olga's comments, I have started writing a spec for this, which I will share in the next couple of days.</div><div><br></div><div>Once we have decided and agreed on the tools and standards we can then start working on a plan to refactor the existing diagrams.</div><div><br></div><div>Just an aside: I have also been looking ta GraphViz as and option to programatically create diagrams using the DOT language.</div><div><br></div><div>Regards</div><div>Shaun</div><div><br></div></div></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, May 13, 2016 at 9:44 AM, Olga Gusarenko <span dir="ltr"><<a href="mailto:ogusarenko@mirantis.com" target="_blank">ogusarenko@mirantis.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div></div><div>Hello, Nate!<br></div><div>Thanks for raising the point, and welcome to docs!<br><br>+ Linette Williams to the discussion. Linette, you probably have something to contribute here.<br><br></div><div>As we discussed with Saun and the team on the Summit, the initial plan is as follows:<br><ol><li>Create the templates for the diagrams (a set of images one can construct anything they want using them).</li><li>Found the tool(s) one could import the templates to it and use it for free.</li><li>Add the diagram recommendations to the contributor guide.</li><li>[future] Revise the existing diagrams.</li></ol><p>I can think of quite a big number of questions to discuss, argue =), and agree upon, and it makes sense to create a spec for this.<br></p><p>What do you think?<br></p><ol></ol></div></div><div class="gmail_extra"><div><div class="h5"><br><div class="gmail_quote">On Fri, May 13, 2016 at 12:17 AM, Matt Kassawara <span dir="ltr"><<a href="mailto:mkassawara@gmail.com" target="_blank">mkassawara@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">A good chunk of the existing diagrams were made in OmniGraffle... mostly because it provides the path of least resistance in terms of time and effort to generate useful diagrams. The documentation build system uses PNG files, a raster format, so we request that any diagrams also include an editable vector version in a separate file, typically something relatively open such as SVG. However, as it turns out, no diagram tool seems to agree on SVG file format, so it often helps to include a third file of the diagram in the native format. The next problem we face is how to instruct new people to make diagrams that conform to some sort of usable standard. Not as easy as words, and explanations of things like line width or shading often depend on the particular application. So, during the Newton cycle, we'd like to determine how to define standards for diagrams and then add them to the contributor guide. </div><div class="gmail_extra"><br><div class="gmail_quote"><div><div>On Thu, May 12, 2016 at 11:53 AM, Nate Archer <span dir="ltr"><<a href="mailto:Nate.Archer@rackspace.com" target="_blank">Nate.Archer@rackspace.com</a>></span> wrote:<br></div></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div>
<div style="word-wrap:break-word;color:rgb(0,0,0);font-size:14px;font-family:Calibri,sans-serif">
<div>Shaun:</div>
<div><br>
</div>
<div>My name is Nate Archer. I’m an information developer at Rackspace looking to become more involved with Openstack. </div>
<div><br>
</div>
<div>Lana Brindley and Darren Chan gave me your name. During the docs planning at Summit, you discussed putting together some diagram recommendations for the Openstack contributor guides. Also in this discussion was Olga, Linnete, Piet, and Matt.</div>
<div><br>
</div>
<div>I’m starting this email thread as a way of beginning the conversation about diagrams.</div>
<div><br>
</div>
<div>As a newbie to Openstack, I would really love to see an updated version of the Logical Architecture diagram for the Ironic contributor guide. </div>
<div><br>
</div>
<div>Do you have any ideas or thoughts? </div>
<div><br>
</div>
<div>Regards,</div>
<div><br>
</div>
<div>Nate Archer</div>
<div>Information Developer I</div>
<div><a href="mailto:Nate.archer@rackspace.com" target="_blank">Nate.archer@rackspace.com</a></div>
<br>
</div>
<br></div></div>_______________________________________________<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" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br></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" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><br></div></div><span class="HOEnZb"><font color="#888888">-- <br><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div><span style="color:rgb(102,102,102)">Best regards,<br></span></div><span style="color:rgb(102,102,102)">Olga Gusarenko<br><br></span></div><span style="color:rgb(102,102,102)">Technical Writer<span><span> | Mirantis, Kharkiv | 38, Lenin av., Kharkiv, Ukraine<br></span></span></span><div><span style="color:rgb(102,102,102)"><a href="mailto:ogusarenko@mirantis.com" target="_blank">ogusarenko@mirantis.com</a> <span><span>| </span></span>skype: gusarenko.olga <span><span>| <a href="tel:%2B38%20%28050%29%20843-14-25" value="+380508431425" target="_blank">+38 (050) 843-14-25</a></span></span><span><span></span></span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div>
</font></span></div>
<br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br></div>