All the content authors within Red Hat use inkscape with a standard set of objects. All
the official Red Hat documentation has diagrams drawn this way, with a common look and
feel. For software engineering diagrams, inkscape is not the best tool, because it does
not have standard UML shapes or any kind of round trip engineering. If you do want to use
inkscape yourself, it would certainly make it easier to incorporate your diagrams into the
docs. I would highly encourage you to do so if it meets your needs.
Some suggested labels for the boxes in the API diagram:
DataCenter/Cluster/Network: Logical Containers
Host/StorageDomain: Physical Resources
API/User/Role: [Security|Authentication|Authorization]
VmPool/Vm/Template: Virtual Machines
Let me know if you like these suggestions and i'll work them into the diagram.
As for the VirtualMachine diagram, I am not in a position to say which attributes are the
'foreign keys' so to speak. If you could draft something up first it would be
helpful.
Thanks
David
----- Original Message -----
From: markllama(a)redhat.com
To: "David Jorm" <djorm(a)redhat.com>
Cc: rhevm-api(a)lists.fedorahosted.org, "Mark McLoughlin"
<markmc(a)redhat.com>
Sent: Tuesday, September 21, 2010 10:03:40 PM GMT +10:00 Brisbane
Subject: Re: [rhevm-api] first diagram of RHEVM RESTful API.
----- "David Jorm" <djorm(a)redhat.com> wrote:
I have created an inkscape diagram based on api.dia and incorporated
it into the REST API Guide DocBook XML. The updates have been
committed to git. Mark, could you please rebuild the version of guide
the on the site?
Unless anyone objects, I will proceed with modifying and incorporating
the other diagrams...
Thanks David. I'm glad these could be of use.
I was intending to label the colored boxes in the API diagram, but I hadn't come up
with good names yet. I'll look at Inkscape myself and may switch to using your
diagrams as the base for anything I do. Dia does have convenient UML shapes, but having
the diagrams in one canonical format is better I think, and if Inkscape is the common way,
that works.
The other diagram needing some major work was the VirtualMachine one. It's way too
busy. I want to remove most of the attribute information from the class boxes that
doesn't relate directly to the relationships between the classes, and then create at
least one new diagram highlighting the relationships between the VirtualMachine and the
Template classes. and the components strictly in common.
I can take some time today to do that, or you can go ahead.
- Mark