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

Marco Fargetta Marco.Fargetta at ct.infn.it
Tue May 12 09:05:26 UTC 2015


+1

I prefer the ascii art in the specs and/or code doumentation.

Figures could be better in other contexts like user and administrator
manuals but they should not go in the code repository in my opinion.

Cheers,
Marco Fargetta



On Mon, May 11, 2015 at 09:11:24PM -0400, Steve Martinelli wrote:
> The Keystone team actually uses ascii diagrams in some of our specs, [0] 
> for instance.
> I might be in the minority here, but I actually like them and find the 
> easy to create and read.
> 
> [0] 
> http://specs.openstack.org/openstack/keystone-specs/specs/kilo/websso-portal.html
> 
> 
> Thanks,
> 
> Steve Martinelli
> OpenStack Keystone Core
> 
> Joe Gordon <joe.gordon0 at gmail.com> wrote on 05/11/2015 05:57:48 PM:
> 
> > From: Joe Gordon <joe.gordon0 at gmail.com>
> > To: OpenStack Development Mailing List 
> <openstack-dev at lists.openstack.org>
> > Date: 05/11/2015 05:59 PM
> > Subject: [openstack-dev] [nova][all] Architecture Diagrams in ascii art?
> > 
> > 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?
> > 
> > [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
> > 
> __________________________________________________________________________
> > 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

> __________________________________________________________________________
> 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 --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/x-pkcs7-signature
Size: 5503 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150512/675379c4/attachment-0001.bin>


More information about the OpenStack-dev mailing list