Add: site generation from documentation (#203)

Add maven site plugin to pom
Add markdown directory for documentation
Add skin config in site.xml
Moved wiki files to markdown directory
Updated README

Author: e-pettersson-ericsson

README.md

@@ -36,54 +36,54 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
 
 # Documentation
 
-1. [**Configuration**](./wiki/Configuration.md)
-1. [**Running Eiffel Intelligence**](./wiki/Running-Eiffel-Intelligence.md)
-    - [**Prerequisites**](./wiki/Running-Eiffel-Intelligence.md#Prerequisites)
-1. [**REST API**](./wiki/REST-API.md)
-    - [**Query aggregated objects**](./wiki/Query.md)
-        - [**Perform query on created aggregated object**](./wiki/Query.md#Perform-query-on-created-aggregated-object)
-        - [**Perform freestyle query on created aggregated object**](./wiki/Query.md#Perform-freestyle-query-on-created-aggregated-object)
-        - [**Example of freestyle query that returns all aggregated objects**](./wiki/Query.md#Example-of-freestyle-query-that-returns-all-aggregated-objects)
-        - [**Query an aggregated object and filter it with specific key**](./wiki/Query.md#Query-an-aggregated-object-and-filter-it-with-specific-key)
-        - [**Query missed notifications**](./wiki/Query.md#Query-missed-notifications)
-    - [**Running rules on objects**](./wiki/Running-rules-on-objects.md)
-        - [**Test JMESPath expression on given Event**](./wiki/Running-rules-on-objects.md#Test-JMESPath-expression-on-given-Event)
-        - [**Test a list of rule sets on given list of events**](./wiki/Running-rules-on-objects.md#Test-a-list-of-rule-sets-on-given-list-of-events) 
-    - [**Authentication**](./wiki/Authentication.md)
-        - [**Check if security is enabled**](./wiki/Authentication.md#Check-if-security-is-enabled)
-        - [**Login point that returns the name of current user**](./wiki/Authentication.md#Login-point-that-returns-the-name-of-current-user)
-        - [**Delete session of current user**](./wiki/Authentication.md#Delete-session-of-current-user)
-        - [**Check if backend is running**](./wiki/Authentication.md#Check-if-backend-is-running)
-    - [**Subscriptions**](./wiki/Subscription-API.md)
-        - [**Create subscriptions**](./wiki/Subscription-API.md#Create-subscriptions)
-        - [**Get subscriptions for the given names**](./wiki/Subscription-API.md#Get-subscriptions-for-the-given-names)
-        - [**Update subscriptions**](./wiki/Subscription-API.md#Update-subscriptions)
-        - [**Delete subscriptions for the given names**](./wiki/Subscription-API.md#Delete-subscriptions-for-the-given-names)
-        - [**Get all subscriptions**](./wiki/Subscription-API.md#Get-all-subscriptions)
-    - [**Download files**](./wiki/Download-Files.md)
-        - [**List available files**](./wiki/Download-Files.md#List-available-files)
-        - [**Download subscription template file**](./wiki/Download-Files.md#Download-subscription-template-file)
-        - [**Download rules template file**](./wiki/Download-Files.md#Download-rules-template-file)
-        - [**Download events template file**](./wiki/Download-Files.md#Download-events-template-file)
-1. [**Rules**](./wiki/Rules.md)
-    - [**Introduction**](./wiki/Rules.md#Introduction)
-    - [**Rule set up**](./wiki/Rules.md#Rule-set-up)
-    - [**Existing rules files**](./wiki/Rules.md#Existing-rules-files)
-    - [**MergeResolverRules**](./wiki/MergeResolverRules.md)
-        - [**Example 1**](./wiki/MergeResolverRules.md#Example-1)   
-        - [**Example 2 - array aggregations**](./wiki/MergeResolverRules.md#Example-2---array-aggregations)  
-    - [**History Rules**](./wiki/History-rules.md)
-1. [**Subscriptions**](./wiki/Subscriptions.md)
-    - [**REST POST notification**](./wiki/REST-POST-notification.md)
-    - [**Email notification**](./wiki/Email-notification.md)
-1. [**Known limitations**](./wiki/Known-limitations.md)
-1. [**Step by Step Aggregation**](./wiki/Step-by-Step-Aggregation.md)
-    - [**ArtifactCreatedEvent Aggregation**](./wiki/ArtifactCreatedEvent-aggregation.md)
-    - [**EiffelTestCaseTriggeredEvent Aggregation**](./wiki/EiffelTestCaseTriggeredEvent-Aggregation.md)
-    - [**EiffelTestCaseStartedEvent Aggregation**](./wiki/EiffelTestCaseStartedEvent-aggregation.md)
-    - [**EiffelTestCaseFinishedEvent Aggregation**](./wiki/EiffelTestCaseFinishedEvent-aggregation.md)
-    - [**EiffelArtifactPublishedEvent Aggregation**](./wiki/EiffelArtifactPublishedEvent-Aggregation.md)
-    - [**EiffelConfidenceLevelModifiedEvent Aggregation**](./wiki/EiffelConfidenceLevelModifiedEvent-Aggregation.md)
-1. [**Step by Step Subscription Notification**](./wiki/Step-by-Step-Subscription-Notification.md)
+1. [**Configuration**](wiki/markdown/Configuration.md)
+1. [**Running Eiffel Intelligence**](wiki/markdown/Running-Eiffel-Intelligence.md)
+    - [**Prerequisites**](wiki/markdown/Running-Eiffel-Intelligence.md#Prerequisites)
+1. [**REST API**](wiki/markdown/REST-API.md)
+    - [**Query aggregated objects**](wiki/markdown/Query.md)
+        - [**Perform query on created aggregated object**](wiki/markdown/Query.md#Perform-query-on-created-aggregated-object)
+        - [**Perform freestyle query on created aggregated object**](wiki/markdown/Query.md#Perform-freestyle-query-on-created-aggregated-object)
+        - [**Example of freestyle query that returns all aggregated objects**](wiki/markdown/Query.md#Example-of-freestyle-query-that-returns-all-aggregated-objects)
+        - [**Query an aggregated object and filter it with specific key**](wiki/markdown/Query.md#Query-an-aggregated-object-and-filter-it-with-specific-key)
+        - [**Query missed notifications**](wiki/markdown/Query.md#Query-missed-notifications)
+    - [**Running rules on objects**](wiki/markdown/Running-rules-on-objects.md)
+        - [**Test JMESPath expression on given Event**](wiki/markdown/Running-rules-on-objects.md#Test-JMESPath-expression-on-given-Event)
+        - [**Test a list of rule sets on given list of events**](wiki/markdown/Running-rules-on-objects.md#Test-a-list-of-rule-sets-on-given-list-of-events) 
+    - [**Authentication**](wiki/markdown/Authentication.md)
+        - [**Check if security is enabled**](wiki/markdown/Authentication.md#Check-if-security-is-enabled)
+        - [**Login point that returns the name of current user**](wiki/markdown/Authentication.md#Login-point-that-returns-the-name-of-current-user)
+        - [**Delete session of current user**](wiki/markdown/Authentication.md#Delete-session-of-current-user)
+        - [**Check if backend is running**](wiki/markdown/Authentication.md#Check-if-backend-is-running)
+    - [**Subscriptions**](wiki/markdown/Subscription-API.md)
+        - [**Create subscriptions**](wiki/markdown/Subscription-API.md#Create-subscriptions)
+        - [**Get subscriptions for the given names**](wiki/markdown/Subscription-API.md#Get-subscriptions-for-the-given-names)
+        - [**Update subscriptions**](wiki/markdown/Subscription-API.md#Update-subscriptions)
+        - [**Delete subscriptions for the given names**](wiki/markdown/Subscription-API.md#Delete-subscriptions-for-the-given-names)
+        - [**Get all subscriptions**](wiki/markdown/Subscription-API.md#Get-all-subscriptions)
+    - [**Download files**](wiki/markdown/Download-Files.md)
+        - [**List available files**](wiki/markdown/Download-Files.md#List-available-files)
+        - [**Download subscription template file**](wiki/markdown/Download-Files.md#Download-subscription-template-file)
+        - [**Download rules template file**](wiki/markdown/Download-Files.md#Download-rules-template-file)
+        - [**Download events template file**](wiki/markdown/Download-Files.md#Download-events-template-file)
+1. [**Rules**](wiki/markdown/Rules.md)
+    - [**Introduction**](wiki/markdown/Rules.md#Introduction)
+    - [**Rule set up**](wiki/markdown/Rules.md#Rule-set-up)
+    - [**Existing rules files**](wiki/markdown/Rules.md#Existing-rules-files)
+    - [**MergeResolverRules**](wiki/markdown/MergeResolverRules.md)
+        - [**Example 1**](wiki/markdown/MergeResolverRules.md#Example-1)   
+        - [**Example 2 - array aggregations**](wiki/markdown/MergeResolverRules.md#Example-2---array-aggregations)  
+    - [**History Rules**](wiki/markdown/History-rules.md)
+1. [**Subscriptions**](wiki/markdown/Subscriptions.md)
+    - [**REST POST notification**](wiki/markdown/REST-POST-notification.md)
+    - [**Email notification**](wiki/markdown/Email-notification.md)
+1. [**Known limitations**](wiki/markdown/Known-limitations.md)
+1. [**Step by Step Aggregation**](wiki/markdown/Step-by-Step-Aggregation.md)
+    - [**ArtifactCreatedEvent Aggregation**](wiki/markdown/ArtifactCreatedEvent-aggregation.md)
+    - [**EiffelTestCaseTriggeredEvent Aggregation**](wiki/markdown/EiffelTestCaseTriggeredEvent-Aggregation.md)
+    - [**EiffelTestCaseStartedEvent Aggregation**](wiki/markdown/EiffelTestCaseStartedEvent-aggregation.md)
+    - [**EiffelTestCaseFinishedEvent Aggregation**](wiki/markdown/EiffelTestCaseFinishedEvent-aggregation.md)
+    - [**EiffelArtifactPublishedEvent Aggregation**](wiki/markdown/EiffelArtifactPublishedEvent-Aggregation.md)
+    - [**EiffelConfidenceLevelModifiedEvent Aggregation**](wiki/markdown/EiffelConfidenceLevelModifiedEvent-Aggregation.md)
+1. [**Step by Step Subscription Notification**](wiki/markdown/Step-by-Step-Subscription-Notification.md)
 
 

docs/_config.yml

@@ -20,12 +20,30 @@
         <output-relative-path>src/main/java</output-relative-path>
         <raml-path>src/main/resources/public/raml/instance_info.raml</raml-path>
         <raml-path>src/main/resources/public/raml/eiffel-intelligence.raml</raml-path>
-        <base-package>com.ericsson.ei.controller</base-package>        
+        <base-package>com.ericsson.ei.controller</base-package>
         <skipTests>false</skipTests>
         <skipITs>${skipTests}</skipITs>
         <skipUnitTests>${skipTests}</skipUnitTests>
     </properties>
 
+    <!-- Reporting Plugins -->
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-project-info-reports-plugin</artifactId>
+                <version>2.8</version>
+                <reportSets><!-- only generating index, no other reports -->
+                    <reportSet>
+                        <reports>
+                            <report>index</report>
+                        </reports>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+        </plugins>
+    </reporting>
+
     <repositories>
         <repository>
             <id>jboss-public-repository-group</id>
@@ -156,7 +174,7 @@
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
             <version>2.6</version>
-        </dependency>      
+        </dependency>
 
         <!-- https://mvnrepository.com/artifact/org.json/json -->
         <dependency>
@@ -280,15 +298,15 @@
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
 
-            <!-- PhoenixNAP RAML Code Generator plugin used to generate sources 
+            <!-- PhoenixNAP RAML Code Generator plugin used to generate sources
                 from raml -->
             <plugin>
                 <groupId>com.phoenixnap.oss</groupId>
                 <artifactId>springmvc-raml-plugin</artifactId>
                 <version>${springmvc-raml-version}</version>
                 <configuration>
                     <!-- path to raml file -->
-                    <ramlPath>${raml-path}</ramlPath>                    
+                    <ramlPath>${raml-path}</ramlPath>
                     <!-- output of generated code -->
                     <outputRelativePath>${output-relative-path}</outputRelativePath>
                     <addTimestampFolder>false</addTimestampFolder>
@@ -354,7 +372,7 @@
                 <version>2.20</version>
                 <configuration>
                     <forkCount>2C</forkCount>
-                    <reuseForks>false</reuseForks>                  
+                    <reuseForks>false</reuseForks>
                     <skipTests>${skipUnitTests}</skipTests>
                     <excludes>
                         <exclude>${someModule.test.excludes}</exclude>
@@ -364,7 +382,7 @@
                     </includes>
                 </configuration>
             </plugin>
-            
+
             <plugin>
                   <groupId>org.apache.maven.plugins</groupId>
                   <artifactId>maven-failsafe-plugin</artifactId>
@@ -407,6 +425,25 @@
                 </configuration>
             </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>
+
         </plugins>
     </build>
 </project>