When I started with Nova (2Q14) I had a hard time to get into it because there weren't enough diagrams for me. Personally, I prefer images over ASCII art. But the package sphinxcontrib-aafig [1] could be a good tradeoff between the people who like ASCII and the others who like to see images. [1] https://pypi.python.org/pypi/sphinxcontrib-aafig/1.0 Joe Gordon <joe.gordon0 at gmail.com> wrote on 05/11/2015 11:57:48 PM: > From: Joe Gordon <joe.gordon0 at gmail.com> > To: OpenStack Development Mailing List <openstack-dev at lists.openstack.org> > Date: 05/12/2015 12:02 AM > 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