Remove mvn site and stop publishing to github-pages (#412)

* Remove mvn site plugin and travis deploy job
* Move all markdown files out to wiki/
* Change links to be relative
* Update front-end links and add links between step by step aggregation guide

Author: e-pettersson-ericsson

.remarkrc

@@ -0,0 +1,6 @@
+{
+  "plugins": [
+    "remark-preset-lint-recommended",
+    ["remark-lint-list-item-indent", false]
+  ]
+}

.travis.yml

@@ -19,13 +19,11 @@ before_install:
   - uname -a
   - chmod +x pom.xml
 
-# Only running report_coverage and deploy stage (after merge) to master branch
+# Only running report_coverage (after merge) to master branch
 stages:
   - test
   - name: report_coverage
     if: branch = master AND type != pull_request
-  - name: deploy
-    if: branch = master AND type != pull_request
 
 # List of jobs to run, tied to specific stages
 jobs:
@@ -43,19 +41,6 @@ jobs:
         - sleep 60
       script:
         - mvn verify -DskipUTs -Djasypt.encryptor.password=integrationtest -Dspring.config.location=src/integrationtests/resources/application.properties -B
-    - stage: deploy
-      name: deployGitHubPages
-      script: skip          # do not run default test scripts
-      install: skip         # do not run default mvn install
-      # Generate site documentation using mvn site plugin
-      before_deploy:
-        - rm -rf docs
-        - mvn site -B
-      deploy:
-        provider: pages
-        skip_cleanup: true
-        github-token: $GITHUB_TOKEN
-        local_dir: docs/
     - stage: report_coverage
       name: report_coverage
       # Generating test coverage report and publishing to Codacy

README.md

@@ -27,7 +27,7 @@ Eiffel Intelligence is a real time data aggregation and analysis solution
 for Eiffel events. While Eiffel represents an event based architecture,
 Eiffel Intelligence addresses the need of stakeholders to view the current
 state of the system by bridging the divide from immutable events to mutable
-state representation. More information [can be found here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/index.md).
+state representation. More information can be found in the below documentation links.
 
 Eiffel Intelligence consists of two components: the Eiffel Intelligence
 back-end (this repository) and the [Eiffel Intelligence front-end](https://github.com/eiffel-community/eiffel-intelligence-frontend),
@@ -45,31 +45,30 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
 
 ## Documentation
 
-1. [**Running Eiffel Intelligence**](wiki/markdown/running-eiffel-intelligence.md)
-    - [**Prerequisites**](wiki/markdown/running-eiffel-intelligence.md#Prerequisites)
-    - [**Configuration**](wiki/markdown/configuration.md)
-    - [**Run in Docker**](wiki/markdown/docker.md)
-2. [**Understanding subscriptions**](wiki/markdown/subscriptions.md)
-    - [**REST POST notification**](wiki/markdown/subscription-with-REST-POST-notification.md)
-    - [**HTTP POST notification to trigger parameterized Jenkins jobs**](wiki/markdown/triggering-jenkins-jobs.md)
-    - [**Email notification**](wiki/markdown/subscription-with-email-notification.md)
-    - [**Step by Step Subscription Notification**](wiki/markdown/step-by-step-subscription-notification.md)
-3. [**Understanding rules**](wiki/markdown/rules.md)
-    - [**What is JMESPath?**](wiki/markdown/rules.md#What-is-JMESPath?)
-    - [**Rule set up**](wiki/markdown/rules.md#Rule-set-up)
-    - [**MergeResolverRules**](wiki/markdown/merge-resolver-rules.md)
-    - [**History Rules**](wiki/markdown/history-rules.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)
-    - [**TestCaseTriggeredEvent Aggregation**](wiki/markdown/test-case-triggered-event-aggregation.md)
-    - [**TestCaseStartedEvent Aggregation**](wiki/markdown/test-case-started-event-aggregation.md)
-    - [**TestCaseFinishedEvent Aggregation**](wiki/markdown/test-case-finished-event-aggregation.md)
-    - [**ArtifactPublishedEvent Aggregation**](wiki/markdown/artifact-published-event-aggregation.md)
-    - [**ConfidenceLevelModifiedEvent Aggregation**](wiki/markdown/confidence-level-modified-event-aggregation.md)
-5. [**REST API**](wiki/markdown/REST-API.md)
-6. [**Compatibility**](wiki/markdown/compatibility.md)
-7. [**Known limitations**](wiki/markdown/known-limitations.md)
-
-**Eiffel Intelligence documentation** [**can be found here**](https://eiffel-community.github.io/eiffel-intelligence/)
+1. [**What is Eiffel Intelligence?**](wiki/index.md)
+2. [**Running Eiffel Intelligence**](wiki/running-eiffel-intelligence.md)
+   - [**Prerequisites**](wiki/running-eiffel-intelligence.md#Prerequisites)
+   - [**Configuration**](wiki/configuration.md)
+   - [**Run in Docker**](wiki/docker.md)
+3. [**Understanding subscriptions**](wiki/subscriptions.md)
+   - [**REST POST notification**](wiki/subscription-with-REST-POST-notification.md)
+   - [**HTTP POST notification to trigger parameterized Jenkins jobs**](wiki/triggering-jenkins-jobs.md)
+   - [**Email notification**](wiki/subscription-with-email-notification.md)
+   - [**Step by Step Subscription Notification**](wiki/step-by-step-subscription-notification.md)
+4. [**Understanding rules**](wiki/rules.md)
+   - [**What is JMESPath?**](wiki/rules.md#What-is-JMESPath?)
+   - [**Rule set up**](wiki/rules.md#Rule-set-up)
+   - [**MergeResolverRules**](wiki/merge-resolver-rules.md)
+   - [**History Rules**](wiki/history-rules.md)
+   - [**Example rules**](wiki/example-rules.md)
+   - [**Mapping Rules To Aggregations**](wiki/mapping-rules-to-aggregations.md)
+5. [**Step by Step Aggregation on Eiffel events**](wiki/step-by-step-aggregation.md)
+   - [**ArtifactCreatedEvent Aggregation**](wiki/artifact-created-event-aggregation.md)
+   - [**TestCaseTriggeredEvent Aggregation**](wiki/test-case-triggered-event-aggregation.md)
+   - [**TestCaseStartedEvent Aggregation**](wiki/test-case-started-event-aggregation.md)
+   - [**TestCaseFinishedEvent Aggregation**](wiki/test-case-finished-event-aggregation.md)
+   - [**ArtifactPublishedEvent Aggregation**](wiki/artifact-published-event-aggregation.md)
+   - [**ConfidenceLevelModifiedEvent Aggregation**](wiki/confidence-level-modified-event-aggregation.md)
+6. [**REST API**](wiki/REST-API.md)
+7. [**Compatibility**](wiki/compatibility.md)
+8. [**Known limitations**](wiki/known-limitations.md)

pom.xml

@@ -556,55 +556,6 @@
                     <failOnMissingWebXml>false</failOnMissingWebXml>
                 </configuration>
             </plugin>
-
-            <plugin>
-                <artifactId>maven-resources-plugin</artifactId>
-                <version>3.1.0</version>
-                <executions>
-                    <execution>
-                        <id>copy-resources</id>
-                        <!-- here the phase you need -->
-                        <phase>pre-site</phase>
-                        <goals>
-                            <goal>copy-resources</goal>
-                        </goals>
-                        <configuration>
-                            <!-- site plugin requires all resources to exist
-                                within resources/ directory -->
-                            <!-- but we don't want to break links in documentation -->
-                            <outputDirectory>${basedir}/wiki/resources/images</outputDirectory>
-                            <resources>
-                                <resource>
-                                    <directory>${basedir}/wiki/markdown/images</directory>
-                                    <includes>
-                                        <include>*.png</include>
-                                    </includes>
-                                </resource>
-                            </resources>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-site-plugin</artifactId>
-                <version>3.7.1</version>
-                <configuration>
-                    <!-- This is where site.xml is located -->
-                    <siteDirectory>${basedir}/wiki</siteDirectory>
-                    <!-- Github pages only generates documentation from docs
-                        directory -->
-                    <outputDirectory>${basedir}/docs</outputDirectory>
-                </configuration>
-                <dependencies>
-                    <dependency>
-                        <groupId>org.apache.maven.doxia</groupId>
-                        <artifactId>doxia-module-markdown</artifactId>
-                        <version>1.8</version>
-                    </dependency>
-                </dependencies>
-            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>cobertura-maven-plugin</artifactId>

wiki/REST-API.md

@@ -0,0 +1,12 @@
+# REST API
+
+Eiffel intelligence provides a REST API for performing CRUD operations on
+the following endpoints:
+
+* [Query](query-aggregated-objects.md) - query Eiffel Intelligence for aggregated objects which fulfills a given condition.
+* [Failed Notifications](failed-notifications.md) - query for failed notifications which fulfills a given condition.
+* [Rules](running-rules-on-objects.md) - test rules work as expected.
+* [Authentication](authentication.md)
+* [Subscriptions](subscription-API.md) - Manage subscriptions (Create, Read, Update, Delete) via HTTP POST requests.
+* [Get templates](templates.md) - Download template files for Eiffel events, subscriptions and rules.
+* [Status](status.md) - Check Eiffel Intelligence status via HTTP POST requests.

wiki/markdown/artifact-created-event-aggregation.md renamed to wiki/artifact-created-event-aggregation.md

@@ -1,5 +1,6 @@
 # ArtifactCreatedEvent Aggregation
 
+## Eiffel Events Are Sent
 Suppose, we publish an “EiffelArtifactCreatedEvent” (given below) on the
 message bus.
 
@@ -57,18 +58,17 @@ message bus.
     }
     }
 
-
 When this message is received at EI, processing begins for possible aggregation
 and notification. In the next step a rules object for the message is extracted.
 The rules object is a set of rules in JSON format that helps extract required
 information from an event by using JMESPath API (for more information about the
-EI rules follow this [link](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/rules.md)). From the rules object,
+EI rules follow this [link](rules.md)). From the rules object,
 “IdentifyRules” is extracted which is a JMESPath identifier of ids and will be
 used to search for all existing aggregated objects linked to the event under
 process. Here it should be noted that rules object path is configured in the
 application.properties file as “rules.path”.
 
-### Rule object extracted from the event under consideration: ###
+## Extract Data from Eiffel Event Based on Rules
 
     {
     "TemplateName": "ARTIFACT_1",
@@ -77,18 +77,15 @@ application.properties file as “rules.path”.
     "IdRule": "meta.id",
     "StartEvent": "YES",
     "IdentifyRules": "[meta.id]",
-    "MatchIdRules": {
-        "_id": "%IdentifyRules_objid%"
-    },
+    "MatchIdRules": { "_id": "%IdentifyRulesEventId%" },
     "ExtractionRules": "{ id : meta.id, type : meta.type, time : meta.time, identity : data.identity, fileInformation : data.fileInformation, buildCommand : data.buildCommand }",
     "DownstreamIdentifyRules": "links | [?type=='COMPOSITION'].target",
-    "DownstreamMergeRules": "{\"externalComposition\":{\"eventId\":%IdentifyRules%}}",
+    "DownstreamMergeRules": "{\"externalComposition\":{\"eventId\":%IdentifyRulesEventId%}}",
     "DownstreamExtractionRules": "{artifacts: [{id : meta.id}]}",
     "HistoryIdentifyRules": "links | [?type=='COMPOSITION'].target",
     "HistoryExtractionRules": "{id : meta.id, identity : data.identity, fileInformation : data.fileInformation}",
     "HistoryPathRules": "{artifacts: [{id: meta.id}]}",
     "ProcessRules": null,
-    "ProcessFunction": null
     }
 
 If no event-linked aggregated object is found, then next step is to check
@@ -108,12 +105,13 @@ aggregated object. It should be noted that this event has no links to any
 aggregated object. However, as it is a start event so a new aggregated object
 is created by extracting information from this event.
 
-### Information Extraction from an Event: ###
-In this step, information from a given event is extracted. This information will then be added into a relevant
-aggregated object. This is what the term aggregation comes from. What
-information is extracted from a given event is encoded in the extraction rules.
-Extraction rules are represented in the rules object with a key named
-“ExtractionRules”. For example, for the current event and rule object,
+## Data Extraction from Event 
+
+In this step, information from a given event is extracted. This information will 
+then be added into a relevant aggregated object. This is what the term aggregation 
+comes from. What information is extracted from a given event is encoded in the 
+extraction rules. Extraction rules are represented in the rules object with a key 
+named “ExtractionRules”. For example, for the current event and rule object,
 following information will be extracted:
 
     {
@@ -143,13 +141,15 @@ next step is to query the database for all the upstream linked objects for this
 event. Then each of the linked object is processed individually. For each
 object, its rule object field “HistoryExtractionRules” is used to extract
 contents from it and merge with the aggregated object. More about the
-“HistoryExtractionRules” can be found [here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/rules.md). Finally, the modified
+“HistoryExtractionRules” can be found [here](rules.md). Finally, the modified
 aggregated object is updated in the database.
 
 On the other hand, If the event is linked to aggregated object(s) then each of
 the aggregated object is processed together with this event. The contents of
 the event to be merged into the aggregated object are extracted and added to
 the aggregated object using “MergeResolverRules”. More about
-“MergeResolverRules” can be found [here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/rules.md). Next, “ProcessRules”
-(if exist) are applied on the aggregated object and the resulting modified
+“MergeResolverRules” can be found [here](rules.md). Next, “ProcessRules”
+(if they exist) are applied on the aggregated object and the resulting modified
 aggregated object is updated in the database.
+
+#### [**Next: Aggregating a TestCaseTriggered Event**](test-case-triggered-event-aggregation.md)

wiki/markdown/artifact-published-event-aggregation.md renamed to wiki/artifact-published-event-aggregation.md

@@ -1,6 +1,7 @@
 # ArtifactPublishedEvent Aggregation
 
-Consider an artifact has been published and EiffelArtifactPublished event is
+## Eiffel Events Are Sent
+Consider an artifact has been published and ArtifactPublishedEvent is
 generated as follow:
 
     {
@@ -43,6 +44,7 @@ generated as follow:
         }
     }
 
+## Extract Data from Eiffel Event Based on Rules
 In the next step rules for this event are extracted:
 
     {
@@ -52,9 +54,7 @@ In the next step rules for this event are extracted:
         "IdRule":"meta.id",
         "StartEvent":"NO",
         "IdentifyRules":"links | [?type=='ARTIFACT'].target",
-        "MatchIdRules":{
-          "_id":"%IdentifyRules_objid%"
-        },
+        "MatchIdRules":{ "_id":"%IdentifyRulesEventId%" },
         "ExtractionRules":"{ eventId : meta.id, time : meta.time, locations : data.locations }",
         "MergeResolverRules":"[ {NONEPATH:NONE}, {publications: [{ eventId: meta.id }]} ]",
         "HistoryIdentifyRules":"",
@@ -63,7 +63,8 @@ In the next step rules for this event are extracted:
         "ProcessFunction":null
     }
 
-Following aggregated object is extracted by using the identify rules:
+## Current Aggregation
+Following aggregated object is extracted by using the IdentifyRules:
 
       {
          "_id": "6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43",
@@ -213,6 +214,7 @@ Following aggregated object is extracted by using the identify rules:
          ]
       }
 
+## Data Extraction from Event 
 Process begins to extract content from the event as specified in the extraction
 rule and puts it in the aggregated object.
 
@@ -233,7 +235,7 @@ And Extracted contents are:
         ]
     }
 
-Next the merge rules template is extracted as:
+Next the merge rules is extracted as:
 
     [{NONEPATH:NONE}, {publications: [{ eventId: meta.id }]}]
 
@@ -262,7 +264,8 @@ Contents are prepared to merge in the object:
         ]
     }
 
-Finally, after merging the content, the merged object looks like this:
+## Updated Aggregation
+Finally, after merging the content, the aggregated object looks like this:
 
     {
         "fileInformation":[
@@ -423,9 +426,8 @@ Finally, after merging the content, the merged object looks like this:
         ]
     }
 
+Next step is to apply the ProcessRules on the aggregated object, but in 
+this case no ProcessRules are defined for this Eiffel event, so this step is skipped.
 
-Next step is to extract the process rules apply on the aggregated object:
-
-In this case, since there are no process rules provided, this step is skipped.
-
+#### [**Next: Aggregating an ConfidenceLevelModified Event**](confidence-level-modified-event-aggregation.md)
 

wiki/markdown/authentication.md renamed to wiki/authentication.md

@@ -19,7 +19,7 @@ the subscriptions.
 When Eiffel Intelligence is configured without LDAP the subscriptions are
 available to anyone to view, edit and delete.
 
-## Check if security is enabled
+## Check if Security is Enabled
 
 Returns the json variable '_security_' that is set to either true or false
 
@@ -33,7 +33,7 @@ Example of response body
 
     {"security":true}
 
-## Login point that returns the name of current user
+## Login Endpoint Returns the Name of Current User
 
 Upon the first time valid credentials are used the response will contain an
 'X-Auth-Token' header that must be saved and attached to any following calls to
@@ -49,7 +49,6 @@ Curl command
 
 Example of full response
 
-
     < HTTP/1.1 200
     < X-Content-Type-Options: nosniff
     < X-XSS-Protection: 1; mode=block
@@ -66,8 +65,7 @@ Example of full response
     * Connection #0 to host localhost left intact
     {"user":"myuser"}
 
-
-## Delete session of current user
+## Delete Session of Current User
 
 Removes the current session bound to the client. If 'X-Auth-Token' is used to
 authenticate then the same token needs to be attached when calling the logout