Slight changes to Francesco's new documentation, format to the standard.
@@ -6,8 +6,8 @@ Three main components are currently defined:
- The Tornado Engine
- The Executors
-The Tornado Engine receives Events from the collectors, checks them against a set of rules, and
-triggers Actions defined on the Rules matched by sending messages to the appropriate executors.
+The Tornado Engine receives Events from the Collectors, checks them against a set of Rules, and
+then triggers Actions defined on the Rules matched by sending messages to the appropriate executors.
@@ -15,18 +15,18 @@ triggers Actions defined on the Rules matched by sending messages to the appropr
An event has a simple structure, composed of:
-- __type__: The Event type identifier (a collector usually sends Events of a single type)
+- __type__: The Event type identifier (a Collector usually sends Events of a single type)
- __created_ts__: The Event creation timestamp in ISO 8601 format
- __payload__: A Map<String, Value> with event-specific data
where the payload __Value__ can be any valid JSON type:
- A __string__
-- A __bool__ value (i.e. true or false)
+- A __bool__ value (i.e., true or false)
- A __number__
-- An __array__ of Values
+- An __array__ of values
- A __map__ of type Map<String, Value>
-All fields are mandatory, although the payload can be an empty structure.
+All fields are mandatory, although the _payload_ can be an empty structure.
Example Event in JSON format:
```json
@@ -46,10 +46,10 @@ Example Event in JSON format:
Like the Event structure, the structure of an Action is rather simple:
-- __id__: The Action type identifier (an executor usually processes a single action type)
-- __payload__: A Map<String, Value> with action-specific data.
+- __id__: The Action type identifier (an Executor usually processes a single Action type)
+- __payload__: A Map<String, Value> with Action-specific data.
-All fields are mandatory, although again the payload can be an empty structure.
+All fields are mandatory, although again the _payload_ can be an empty structure.
Example Action in JSON format:
```json
