[openstack-dev] [neutron] Neutron BP review process for Juno

Nachi Ueno nachi at ntti3.com
Wed Apr 16 19:19:02 UTC 2014


Hi folks

I don't think to use ASCII digrams is good idea because it is hard to
maintenance & update
 diagrams..
so I would like to recommend Blockdiag & Netdiag which are plugins for sphinx.

Blockdiag
http://blockdiag.com/en/blockdiag/

blockdiag {
   A -> B -> C -> D;
   A -> E -> F -> G;
}

will be
http://blockdiag.com/en/_images/blockdiag-69b48ddf499e79e437fbdf9f0e767e365f846d7a.png

(see more example
http://blockdiag.com/en/blockdiag/examples.html )

or you can try online http://blockdiag.appspot.com/

NetDiag
http://blockdiag.com/en/nwdiag/

nwdiag {
  network dmz {
      address = "210.x.x.x/24"

      web01 [address = "210.x.x.1"];
      web02 [address = "210.x.x.2"];
  }
  network internal {
      address = "172.x.x.x/24";

      web01 [address = "172.x.x.1"];
      web02 [address = "172.x.x.2"];
      db01;
      db02;
  }
}

will be

http://blockdiag.com/en/_images/nwdiag-472a0e8ead9b236d7d929e645767514615bb2392.png

try
http://blockdiag.appspot.com/nwdiag/

http://blockdiag.com/en/nwdiag/nwdiag-examples.html

We have more diagrams can be generated

Activity diagram
http://blockdiag.appspot.com/actdiag/

Sequence diagram
http://blockdiag.appspot.com/seqdiag/

Best
Nachi

2014-04-16 10:42 GMT-07:00 Kyle Mestery <mestery at noironetworks.com>:
> On Wed, Apr 16, 2014 at 12:23 PM, Russell Bryant <rbryant at redhat.com> wrote:
>> On 04/16/2014 09:51 AM, Russell Bryant wrote:
>>> On 04/16/2014 09:39 AM, Salvatore Orlando wrote:
>>>> if the image you're adding is a diagram, I would think about
>>>> asciiflow.com <http://asciiflow.com> first!
>>>
>>> In all seriousness, I think that's a very nice solution for simple
>>> diagrams.  :-)
>>>
>>> For other diagrams, I wonder if it makes sense to just upload them to
>>> the wiki and include links to them from the spec using the image directive.
>>>
>>
>> Another thread got started on this topic for Nova.
>>
>> I put up a proposal to require ASCII digrams for nova-specs here:
>>
>> https://review.openstack.org/#/c/88028/
>>
> Great idea! I've done the same for neutron-specs here:
>
> https://review.openstack.org/88037
>
>
>> --
>> Russell Bryant
>>
>> _______________________________________________
>> OpenStack-dev mailing list
>> OpenStack-dev at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



More information about the OpenStack-dev mailing list