Transfer wiki pages from git wiki to main repo (#102)

* Transfer wiki pages from git wiki to main repo

Author: erik-edling

README.md

@@ -34,3 +34,15 @@ To get involved, please see [Code of Conduct](./CODE_OF_CONDUCT.md) and [contrib
 This repository forms part of the Eiffel Community. Eiffel is a protocol for technology agnostic machine-to-machine communication in continuous integration and delivery pipelines, aimed at securing scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it.
 
 Visit [Eiffel Community](https://eiffel-community.github.io) to get started and get involved.
+
+# Documentation
+
+1. [**GUI Overview**](./wiki/GUI-Overview.md)
+1. [**Subscription Handling**](./wiki/Subscription-Handling.md)
+    -  [**Add Subscription**](./wiki/Add-Subscription.md)
+1. [**Test Rules**](./wiki/Test-Rules.md)
+    - [**Rule testing mechanism via "Test Rules" GUI interface**](./wiki/Test-Rules.md#Rule-testing-mechanism-via-Test-Rules-GUI-interface)
+    - [**Introduction**](./wiki/Test-Rules.md#Introduction)
+    - [**Aggregated object**](./wiki/Test-Rules.md#Aggregated-object)
+    - [**Rule set up**](./wiki/Test-Rules.md#Rule-set-up)
+    - [**The most common operation you would do**](./wiki/Test-Rules.md#The-most-common-operation-you-would-do)

src/main/resources/application.properties

@@ -28,7 +28,7 @@ ei.backendInstancesFilePath=
 ei.eiffelDocumentationUrls={ "EI Frontend GitHub": "https://github.com/eiffel-community/eiffel-intelligence-frontend",\
                              "EI Backend GitHub": "https://github.com/eiffel-community/eiffel-intelligence",\
                              "Eiffel Github main page": "https://github.com/eiffel-community/eiffel",\
-                             "Test Rules User Guide": "https://github.com/eiffel-community/eiffel-intelligence/wiki/TestRulesUserGuide" }
+                             "Test Rules User Guide": "https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/TestRulesUserGuide.md" }
 
 #### LOGGING #########
 logging.level.root: INFO

wiki/Add-Subscription.md

@@ -0,0 +1,21 @@
+# Add Subscription
+
+This form is used to add subscription through frontend GUI. Here is a description of the elements available on this form.
+
+**Load Subscription Template:** In this dropdown list options are given to select a specific template for the subscription form. Currently, the following options are listed: Jenkins Pipeline Parametrized Job Trigger, REST POST and Mail Trigger.
+
+**SubscriptionName:** A field to give a name to the current subscription. Only letters, underscore and numbers are allowed in this field.
+
+**NotificationType:** A dropdown list with two options, i.e., REST POST and Mail Trigger, depending on how a subscriber want to be notified when a subscription is fulfilled.
+
+**RestPostMediaType:** A dropdown list that provides options for selecting a specific form content type. The options available in the list depends on the selected template type.
+
+**NotificationMessage:** It is used to send a message to a specific client. The format of the message depends on the options selected in the NotificationMessage and RestPostMediaType. A button, “Add Key/Value pair”, in this field may be used to add more messages.
+
+**Authorization:** A list to select authorization type. Currently, only one authorization type is provided which is “BASIC_AUTH”. The option “NO_AUTH” implies that authorization is not required.
+
+**Repeat:** A drop down list to choose either true or false. It depends whether same subscription should be re-triggered for new additions to the aggregated object. If false, the notification will be triggered only the first time when conditions are fulfilled. 
+
+**NotificationMeta:** A unique address need to be added for notification.
+
+**Requirement:** It is used to add a requirement, which need to be fulfilled before a subscription is triggered. Requirement is added in the form of a condition (with a specific format). More than one conditions may be added under one requirement by using “Add Condition” button. It should be noted that conditions under one requirement are connected by logical “AND”. Thus all conditions udder one requirement need to be satisfied before a subscription is triggered. More than one requirements may be added by “Add Requirement” button. Requirements are connected by logical “OR”.

wiki/GUI-Overview.md

@@ -0,0 +1,9 @@
+# GUI Overview
+
+Eiffel Intelligence Frontend GUI can be divided into two parts a navigation window and a work window.
+<img src="https://github.com/eiffel-community/eiffel-intelligence-frontend/blob/master/src/main/resources/static/assets/images/GUI_subscription_example.png">
+</img>
+
+As the name suggests, navigation window provides its users one click access to the resources to interact with EI. This window contains some buttons. Clicking on any of these buttons result in either opening an interactive form in the work window or opening a new window with some information resource.
+
+A detailed description of the interactive elements present in the navigation window and corresponding interactions in the work window is described in the following pages.

wiki/Home.md

@@ -0,0 +1,4 @@
+Eiffel Intelligence Frontend provides Eiffel Intelligence (EI) users a simple and easy to use GUI. More precisely, Eiffel Intelligence Frontend allows the configuration of subscription and aggregation rules in Eiffel Intelligence through a graphical interface.
+
+EI has two components, namely Eiffel Intelligence (Backend) and Eiffel Intelligence Frontend. In Eiffel GitHub these two components are represented by two different repositories. Eiffel Intelligence (Backend) implements core functionalities of EI and Eiffel Intelligence Frontend take care of the user interactions through an interface.
+

wiki/Subscription-Handling.md

@@ -0,0 +1,20 @@
+# Subscription Handling
+
+Clicking on the Subscription Handling element will display some buttons in main page which help perform a number of subscription related actions. A table may become visible, which is populated by the information about the stored (if any) subscriptions in the connected database. This view is also the default view of the Eiffel Intelligence Frontend, once the authentication (if enabled)is done .
+
+#### _Add Subscription_ 
+This button opens a form with a number of fields to create a subscription through subscription endpoint (POST /subscriptions). 
+#### _Reload_ 
+This button reloads the data from the database and refresh the data in the subscription table
+#### _Bulk Delete_
+This button deletes all the selected subscriptions in the table from the database.
+#### _Get Template_
+This button downloads a subscription template
+#### _Upload Subscriptions_
+This button help uploads a subscription by opening a file explorer
+#### _EI Backend Status_
+This button indicates, through its colour, whether a backend instance is connected with frontend or not. The green colour means backend is connected while red means no instance is connected.
+#### _Search_
+To search subscriptions with matching names in the database (displayed in the table).
+
+**_More Subscriptions related information can be found [here](https://github.com/eiffel-community/eiffel-intelligence/tree/master/wiki/Subscription-API.md) and [here](https://github.com/eiffel-community/eiffel-intelligence/tree/master/wiki/Subscriptions.md)_**