Merge pull request #5 from azerion/NAT-404

Add event dashboard help texts

docs/console/game/devices/devices/index.md

@@ -0,0 +1,33 @@
+# Devices
+On this page devices can be configured. These devices can be used in the event dashboard pages. When you add a device here the events for said device will be stored when it is enabled.
+
+## Contents
+- [Create a device](#create-a-device)
+- [Edit a device](#edit-a-device)
+- [Enable/Disable a device](#enable-disable-a-device)
+- [Remove a device](#remove-a-device)
+
+### Create a device
+To create a device:
+1. Click on the button **Create devices**
+2. Fill in the Device_id (as gotten from the app), Alias, Platform and Enabled (should this device be tracked)
+3. Click **Save**
+
+### Edit a device
+To edit a device:
+1. Find the device that you want to edit in the list of devices (by using the search button ![search](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/search.png) on the top left for example)
+2. Click the ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button for that row
+3. A pop-up will show in which you can edit the values for your device
+4. When done press **Save**
+
+### Enable/Disable a device
+To enable/disable a device:
+1. Find the device that you want to enable/disable in the list of devices (by using the search button ![search](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/search.png) on the top left for example)
+2. Click the ![remove-circle](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/remove-circle.png) or ![ok-circle](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/ok-circle.png) button for that row
+3. Confirm that you want to enable/disable the device by clicking ok on the confirmation pop-up
+
+### Remove a device
+To remove a device:
+1. Find the device that you want to remove in the list of devices (by using the search button ![search](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/search.png) on the top left for example)
+2. Click the ![trash](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/trash.png) button for that row
+2. Confirm that you want to remove the device in the pop-up

docs/console/game/event_dashboard/overview/index.md

@@ -0,0 +1,26 @@
+# Overview
+On this page you can see an overview of which events have been sent in a period of time. The listing will show the last occurance of the event and how many times this event has been sent.
+
+## Contents
+- [Viewing the overview](#viewing-the-overview)
+- [Explanation of columns](#explanation-of-columns)
+
+### Viewing the overview
+To view the overview for a device:
+1. Check the statusses you want to see (most of the time you will want all)
+2. Select the daterange and the device you want to see
+3. Press the **Save** button
+4 You'll now see events that have been sent in the period in the table below, more on that.
+
+### Explanation of columns
+There are some columns that may not be clear initially. See the columns and what their value means below:
+* Event: the name of the event
+* Configured: when false it indicates that this is an event that games should manually configure in the game's event page.
+* Status: there are three statusses: 
+    * OK indicates everything was ok
+    * WARNING indicates the event had to be altered or something wasn't alright during event validation but the event still could be sent through
+    * ERROR the event had serious validation issues and was dropped because of that, error events should always be checked as these events won't get anywhere in the system
+* Validation result: the result of the validation, this gives more insight if the status was not OK
+* Total: total amount of events received in the given timeframe
+* Last seen: when was the event last seen
+* Action: in the action field is an info button, when pressed it'll pop up a window with the event and its response

docs/console/game/event_dashboard/stream/index.md

@@ -0,0 +1,40 @@
+# Live stream
+On this page the events that have been sent to our system can be seen and evaluated. This happens through a live stream that almost directly shows events as they come into our system. 
+
+## Contents
+- [Starting up the live stream](#starting-up-the-live-stream)
+- [Stopping/continuing the live stream](#stopping-continuing-the-live-stream)
+- [Event list](#event-list)
+    - [Statuses](#statuses)
+    - [Event details](#event-details)
+- [Testing with multiple devices](#testing-with-multiple-devices)
+
+### Starting up the live stream
+Before starting up the live stream you wil need to set up your device in the devices tab. If no devices have yet been set up the page will direct you there. Assuming you have set up your device starting the live stream is easy:
+1. To start streaming press the **+** button
+2. Select the device you want to track
+3. The interface changes and you see the stream view
+4. When sending events through the SDK, from the device on this game, you should now see them appear in the event list
+
+### Stopping/continuing the live stream
+To stop the live stream just click the **Listening** button on the right. To continue the stream press the same button that has now the **Play** text.
+
+### Event list
+
+#### Statuses
+Events on the events list are marked in different colors. Green, orange (yellow in the list) and red. The color indicates if the event passed the event validation (ok, green), the event validation had minor issues which it could correct (warning, orange) or the event was not accepted and dropped (error, red). Note that errors are serious and should be investigated and builds containing them should be fixed before release.
+
+On the top right is a pie chart that shows how many error, ok and warning events came in.
+
+#### Event details
+When clicking on an event in the event list on the right you will see the details of the event. It'll show the:
+ * **Warnings** and **errors** that the event had
+ * **Event** that was sent itself
+ * **Response** that was sent back (if it is too long the data part may be shortened, but can be seen in the full response, except for responses to requestUserData where the gamestate part is removed before storing the event)
+ * **Complete Event Data** which holds everything that was stored for this event, the event, the full response and the validation result. If in the **Response** part some data has been shortened it can be seen here. 
+
+### Testing with multiple devices
+On this page it is possible to perform tests on multiple devices at once.
+At the top where you can select a device the **+** button will stay if multiple devices are added for the game, so you can keep adding more devices after you selected the first one.
+
+When you are testing multiple devices the numbers next to the device name indicate how many occurances of the events were ok, warning and errors on **inactive** tabs. This is so you can easily see if one device fails where others succeed while testing.

docs/console/game/event_dashboard/testing/config.md

@@ -0,0 +1,29 @@
+# Testrail Config
+This page contains the configuration that is needed to connect to testrail, with which we can store what we configure in the **testrail** tab. To get this set up please contact the gamedock team. Next to that we can create **abstracts**. Abstracts are constant values which can be used in the testail tests. For example a package_id that is used in multiple tests can be configured as an abstract.
+
+## Contents
+- [Create an abstract](#create-an-abstract)
+- [Edit an abstract](#edit-an-abstract)
+- [Remove an abstract](#remove-an-abstract)
+
+### Create an abstract
+To create an abstract:
+1. Click on the button **Create abstract**
+2. Fill in the Name, Value
+3. Click **Save**
+
+#### What's next?
+After creating an abstract you can use it in testrail event tests
+
+### Edit an abstract
+To edit an abstract:
+1. Find the abstract that you want to edit in the list of abstracts (by using the search button ![search](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/search.png) on the top left for example)
+2. Click the ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button for that row
+3. A pop-up will show in which you can edit the values for your abstract
+4. When done press **Save**
+
+### Remove an abstract
+To remove an abstract:
+1. Find the abstract that you want to remove in the list of abstracts (by using the search button ![search](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/search.png) on the top left for example)
+2. Click the ![trash](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/trash.png) button for that row
+2. Confirm that you want to remove the abstract in the pop-up

docs/console/game/event_dashboard/testrail/create.md

@@ -0,0 +1,46 @@
+# Create Test Case
+In this page you can create new Testrail test cases.
+
+## Contents
+- [What is a test case?](#what-is-a-test-case)
+- [Title](#title)
+- [Section Id](#section-id)
+- [Steps](#steps)
+    - [Creating/Editing a step](#creatingediting-a-step)
+        - [Description](#description)
+        - [SDK Method](#sdk-method)
+        - [Event Name](#event-name)
+        - [Event Data](#event-data)
+
+
+### What is a test case?
+A test case is a series of steps that have be done in order to complete the test case. Every step includes an event that have to be triggered with a specific set of data in order for the step to be considered complete.
+
+
+### Title
+A descriptive title of the test case
+
+### Section Id
+The section that the test case will belong to
+
+### Steps
+A list of the steps that the the Test Case consist from. You can add steps by clicking on the **Add Step** button, edit them by clicking on their name in the list, and remove them by pressing the bucket button next to them.
+
+#### Creating/Editing a step
+A step consists of:
+* A Description
+* An SDK Method
+* An Event Name
+* Event data
+
+##### Description
+The description should be a small description of the step, it should be enough to give details to the reader of the actions that they have to take.
+
+##### SDK Method
+The SDK Method that will be triggered on said action.
+
+##### Event Name
+The name of the Event that will be triggered after said action. After selecting the event, the form will change to include the relevant Event Data that are supported by the event.
+
+##### Event Data
+The data that the event needs to have in order for the event to be considered valid.

docs/console/game/event_dashboard/testrail/index.md

@@ -0,0 +1,51 @@
+# Testrail
+This page contains all the tests that are defined in Testrail. In this page it is possible to create and edit tests cases and manage the sections.
+
+## Contents 
+- [Create a section/subsection](#create-a-sectionsubsection)
+- [Edit a Section/Subsection](#edit-a-sectionsubsection)
+- [Delete a Section/Subsection](#edit-a-sectionsubsection)
+- [Create a case](#create-a-case)
+- [Edit a case](#edit-a-case)
+- [Delete a case](#delete-a-case)
+
+
+### Create a Section/Subsection:
+To create sections and subsections:
+ 1. click on the `Add Section` or `Add Subsection` buttons respectively.
+ 2. Fill in the name and the description of the Section/Subsection
+ 3. click **Save**
+ You can create any number of sections/subsections and as many levels as you want. In general, deeper than three levels is more difficult to manage.
+
+### Edit a Section/Subsection
+To Edit a Section/Subsection:
+1. Hover on a Section/Subsection, the `edit` and `delete` icons will be shown  next to it.
+2. Click the edit (pencil) icon.
+3. Fill the name and the description of the Section/Subsection
+4. Click **Save**
+
+### Delete a Section/Subsection
+To delete a Section/Subsection:
+1. Hover on a Section/Subsection, the `edit` and `delete` icons will be shown  next to it.
+2. Click the delete (red bucket) icon.
+3. You will be prompted to approve the action.
+4. Click **ok** to delete, **cancel** to cancel the action.
+When deleting a section/Subsection **all Sections/Subsections inside it** will be deleted as well.
+
+### Create a case
+To create a case:
+1. Click on the `add case` button
+2. You will be redirected to a new page with the `Add Test Case` form
+
+### Edit a case
+To edit a case:
+1. Hover on a case to show the `edit` and `delete` icons next to it.
+2. Click the edit (pencil) icon.
+2. You will be redirected to a new page with the `Edit Test Case` form
+
+### Delete a case
+To delete a case:
+1. Hover on a case to show the `edit` and `delete` icons next to it.
+2. Click the delete (red bucket) icon.
+3. You will be prompted to approve the action.
+4. Click **ok** to delete, **cancel** to cancel the action.

docs/console/management/events/index.md

@@ -1,5 +1,5 @@
 # Events
-On this age you can configure global events. These events can be used by all games. Some of them are called by the SDK automatically some have to be integrated manually in the game (this is reflected in the field integration).
+On this page you can configure global events. These events can be used by all games. Some of them are called by the SDK automatically some have to be integrated manually in the game (this is reflected in the field integration).
 Next to creating the event you can set various properties by clicking on a row, which will expand the extra option to the right (Setting up what services to call, in which SDK versions this event is applicable) and below (Setting properties of the event) the table.
 
 ## Contents