[openstack-dev] [nova][all] Architecture Diagrams in ascii art?

Angus Salkeld asalkeld at mirantis.com
Wed May 13 21:59:00 UTC 2015


On Tue, May 12, 2015 at 8:22 AM, Steve Baker <sbaker at redhat.com> wrote:

> On 12/05/15 09:57, Joe Gordon wrote:
>
>> 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.
>>
>> 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).
>>
>> So how can we do better then ascii art architecture diagrams?
>>
>>  How about ascii source diagrams?
>
>> [0] http://docs.openstack.org/developer/heat/architecture.html
>> [1] http://docs.openstack.org/developer/keystone/architecture.html
>> [2] http://docs.openstack.org/developer/nova/devref/architecture.html
>>
>>
> These are all sphinx generated documents, so we could use something like
> blockdiag to generate all manner of diagrams
> https://pypi.python.org/pypi/sphinxcontrib-blockdiag
> http://blockdiag.com/en/


+1 maybe we can trial it in Heat specs?

-Angus


>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150514/5ae22b98/attachment.html>


More information about the OpenStack-dev mailing list