[tor-commits] [ooni-probe/master] Add glossary with list of terms we use in OONI

[isis at torproject.org]

commit 9d56a842363e0017992ba087f9b89547c893d163
Author: Arturo Filastò <arturo at filasto.net>
Date:   Fri Oct 26 21:17:23 2012 +0000

    Add glossary with list of terms we use in OONI
---
 docs/source/glossary.rst |   16 ++++++++++++++++
 docs/source/index.rst    |    1 +
 2 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
new file mode 100644
index 0000000..417d8a8
--- /dev/null
+++ b/docs/source/glossary.rst
@@ -0,0 +1,16 @@
+Glossary
+========
+
+Here we will summarize some of the jargon that is unique to OONI.
+
+**Test Case**: a set of measurements performed on a to be tested network that
+are logically grouped together
+
+**Report**: is the output of a test run containing all the information that is
+require for a researcher to assess what is the output of a test.
+
+**Yamlooni**: The format we use for Reports, that is based on YAML.
+
+**Input**: What is given as input to a TestCase to perform a measurement.
+
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9de0dba..e92cc5a 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -47,5 +47,6 @@ Contents
     tutorial
     writing_tests
     api/*
+    glossary