Rename "existing rules file" to example rules (#335)

* Rename "existing rules file" to example rules.

Author: e-pettersson-ericsson

README.md

@@ -59,7 +59,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
     - [**Rule set up**](wiki/markdown/rules.md#Rule-set-up)
     - [**MergeResolverRules**](wiki/markdown/merge-resolver-rules.md)
     - [**History Rules**](wiki/markdown/history-rules.md)
-    - [**Existing rules files**](wiki/markdown/existing-rules-files.md)
+    - [**Example rules**](wiki/markdown/example-rules.md)
     - [**Mapping Rules To Aggregations**](wiki/markdown/mapping-rules-to-aggregations.md)
 4. [**Step by Step Aggregation on Eiffel events**](wiki/markdown/step-by-step-aggregation.md)
     - [**ArtifactCreatedEvent Aggregation**](wiki/markdown/artifact-created-event-aggregation.md)

wiki/markdown/example-rules.md

@@ -0,0 +1,24 @@
+# Example rules
+
+We have created some example rules that represent use cases which triggered 
+the development of Eiffel Intelligence. The files containing the rules 
+can be found [**here**](https://github.com/eiffel-community/eiffel-intelligence/tree/master/src/main/resources/rules).
+
+We have also illustrated the Eiffel event flows which these example rules 
+need, to perform the aggregation. The illustrations contain the events 
+and how they are linked together.
+
+## Flow with the events required for Artifact object flow.
+
+<img src="images/ArtifactRules.png">
+</img>
+
+## Flow with the events required for SourceChange object flow.
+
+<img src="images/SourceChangeRules.png">
+</img>
+
+## Flow with the events required for TestExecution object flow.
+
+<img src="images/test-executionRules.png">
+</img>

wiki/markdown/existing-rules-files.md

@@ -1,18 +1,28 @@
 # Merge Resolver Rules
 
-JMESPath identifier of the place where to insert the JSON object from
-_"ExtractionRules"_. If MergeResolverRules is null _"ExtractionRules"_ object
-will be inserted to the root of aggregated object.
-
-The location in the aggregated object where the extracted content will be merge
-can be specified with path elements and a value to exist at that, but not all
-elements of a path are needed. The aggregated object will be flattened and all
-paths that contains the path elements in the given order will be collected.
-Then we check the value and the path with the value is the winning path. If no
-value from the paths match the given value then we take the longest path that
-contains the given path elements.
-
-Example object:
+The **MergeResolverRules** is a JMESPath identifier which tells Eiffel 
+Intelligence the place where to insert the JSON object extracted from 
+**ExtractionRules**. If **MergeResolverRules** is null, the **ExtractionRules** 
+object will be inserted to the root of aggregated object.
+
+## Specifying location with MergeResolverRules
+The location in the aggregated object where the extracted content will be 
+merged, can be specified with path elements. The path element needs a 
+value to exist, but not all elements of a path are needed. The aggregated 
+object will be flattened and all paths that contains the path elements in 
+the given order will be collected. Then we check the value, and the path 
+which contains the value is the winning path. If no value from the paths 
+match the given value then we take the longest path that contains the 
+given path elements.
+
+If you want to place the extracted content into the root of the aggregated
+object you can choose to specify a location key which does not exist in 
+the aggregated object, and there Eiffel Intelligence will not find this
+location. In our example rules we use the non-existing key and value 
+**NONEPATH:NONE** to make Eiffel Intelligence place the content at the 
+root of the object. 
+
+Example aggregated object:
 
     {
        "id":"eventId",
@@ -63,7 +73,8 @@ Example object:
 
     "MergeResolverRules" : "{level2:{event_id: %IdentifyRules%}}"
 
-will result after replacing the marker by EI in rule:
+This rule will be interpreted by Eiffel Intelligence which replaces the 
+marker %IdentifyRules% with a processed value, resulting in the following rule:
 
     {level2:{event_id: someLevelId}}
 

wiki/markdown/merge-resolver-rules.md

@@ -52,7 +52,7 @@
             <item collapse="true" name ="Understanding rules" href="rules.html">
                 <item name="Merge Resolver Rules" href="merge-resolver-rules.html" />
                 <item name="History Rules" href="history-rules.html" />
-                <item name="Existing Rules" href="existing-rules-files.html" />
+                <item name="Example Rules" href="example-rules.html" />
                 <item name="Mapping Rules To Aggregations" href="mapping-rules-to-aggregations.html" />
             </item>
             <item collapse="true" name="Step-by-step aggregation" href="step-by-step-aggregation.html">