Skip to content

Commit f4e312c

Browse files
Update test rules user guide (#119)
* Move and add images for documentation * Update Test Rules documentation
1 parent 6d8e189 commit f4e312c

16 files changed

+262
-640
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,4 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
4545
1. [**GUI Overview**](./wiki/GUI-Overview.md)
4646
1. [**Subscription Handling**](./wiki/Subscription-Handling.md)
4747
- [**Add Subscription**](./wiki/Add-Subscription.md)
48-
1. [**Test Rules**](./wiki/Test-Rules.md)
49-
- [**Rule testing mechanism via "Test Rules" GUI interface**](./wiki/Test-Rules.md#Rule-testing-mechanism-via-Test-Rules-GUI-interface)
50-
- [**Introduction**](./wiki/Test-Rules.md#Introduction)
51-
- [**Aggregated object**](./wiki/Test-Rules.md#Aggregated-object)
52-
- [**Rule set up**](./wiki/Test-Rules.md#Rule-set-up)
53-
- [**The most common operation you would do**](./wiki/Test-Rules.md#The-most-common-operation-you-would-do)
48+
1. [**Test Rules User Guide**](./wiki/Test-Rules.md)

src/main/resources/application.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ei.backendInstancesListJsonContent=[{ "contextPath": "", "port": "8090", "name":
2525
ei.eiffelDocumentationUrls={ "EI Frontend GitHub": "https://github.com/eiffel-community/eiffel-intelligence-frontend",\
2626
"EI Backend GitHub": "https://github.com/eiffel-community/eiffel-intelligence",\
2727
"Eiffel Github main page": "https://github.com/eiffel-community/eiffel",\
28-
"Test Rules User Guide": "https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/TestRulesUserGuide.md" }
28+
"Test Rules User Guide": "https://github.com/eiffel-community/eiffel-intelligence-frontend/blob/master/wiki/Test-Rules.md" }
2929

3030
#### LOGGING #########
3131
logging.level.root: INFO
Binary file not shown.

src/main/resources/static/resources/testRules_constants.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Short usage description of test rules
22
var test_rule_info = '1. Load buttons are for loading rules/events from external files.\n' +
33
' It is possible to choose if you want to append or replace\n' +
4-
' aready written rules/events in the text areas.\n'+
4+
' already written rules/events in the text areas.\n'+
55
' * The file content should be formatted as JSON objects in\n' +
66
' a JSON list, ex. [{Object1}, {Object2}].\n' +
77
'\n2. By clicking on "Get Template" buttons you will download rules\n' +

src/main/resources/templates/testRules.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h5 class="modal-title">Usage Information</h5>
165165
<div class="modal-body modal-height-fit">
166166
<p id="infoContent" class="pre"></p>
167167
<div class="text-center">
168-
<a href="https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/TestRulesUserGuide.md" target="_blank" rel="noopener noreferrer" style="text-decoration: none;">Test Rules User Guide</a>
168+
<a href="https://github.com/eiffel-community/eiffel-intelligence-frontend/blob/master/wiki/Test-Rules.md" target="_blank" rel="noopener noreferrer" style="text-decoration: none;">Test Rules User Guide</a>
169169
</div>
170170
</div>
171171
<div class="modal-footer">

wiki/GUI-Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GUI Overview
22

33
Eiffel Intelligence Frontend GUI can be divided into two parts a navigation window and a work window.
4-
<img src="https://github.com/eiffel-community/eiffel-intelligence-frontend/blob/master/src/main/resources/static/assets/images/GUI_subscription_example.png">
4+
<img src="./images/GUI_subscription_example.png">
55
</img>
66

77
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.

wiki/Test-Rules.md

Lines changed: 257 additions & 630 deletions
Large diffs are not rendered by default.

wiki/images/GUI_TestRules.png

45.3 KB
Loading
99.4 KB
Loading
70 KB
Loading

0 commit comments

Comments
 (0)