From 9799551350162c209efed8c2848cb7faef2377d7 Mon Sep 17 00:00:00 2001 From: Kyle Mestery Date: Tue, 15 Apr 2014 01:20:49 +0000 Subject: [PATCH] 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 --- specs/template.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specs/template.rst b/specs/template.rst index 0798e87c1..6558d82c7 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -33,6 +33,13 @@ Some notes about using this template: * To test out your formatting, build the docs using tox, or see: 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 ===================