Note the usage of asciiflow.com for diagrams
Anyone who's spec has diagrams or figures is encouraged to use asciiflow.com to generate the diagrams and figures. Change-Id: I999d6eb3a4b0d48f276e273814dd351057b70c87
This commit is contained in:
parent
4f354e9fd2
commit
9799551350
|
@ -33,6 +33,13 @@ Some notes about using this template:
|
||||||
* To test out your formatting, build the docs using tox, or see:
|
* To test out your formatting, build the docs using tox, or see:
|
||||||
http://rst.ninjs.org
|
http://rst.ninjs.org
|
||||||
|
|
||||||
|
* If you would like to provide a diagram with your spec, ascii diagrams are
|
||||||
|
required. http://asciiflow.com/ is a very nice tool to assist with making
|
||||||
|
ascii diagrams. The reason for this is that the tool used to review specs is
|
||||||
|
based purely on plain text. Plain text will allow review to proceed without
|
||||||
|
having to look at additional files which can not be viewed in gerrit. It will
|
||||||
|
also allow inline feedback on the diagram itself.
|
||||||
|
|
||||||
|
|
||||||
Problem description
|
Problem description
|
||||||
===================
|
===================
|
||||||
|
|
Loading…
Reference in New Issue