Skip to content

Commit 9692deb

Browse files
e-pettersson-ericssone-pettersson-ericsson
authored
Add: site generation from documentation (#126)
Add maven site plugin to pom file and updated with reporting config Moved documentation into markdown directory to be rendered properly by plugin and then published to github pages from docs/ directory. Add resource plugin to copy additional resources (images) during site phase. Maven site plugin requires additional resources to exist within siteDirectory/resources/ to be rendered properly The problem is the links has to work both on github pages (rendered html pages) and in the repository .md files To avoid having conflicts with links in documentation the images are copied to the resources/images/ directory during site phase Upon clean up this directory is also removed, to avoid having duplicates. Generated docs directory
1 parent e5fbd27 commit 9692deb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2406
-492
lines changed

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
4242

4343
# Documentation
4444

45-
1. [**GUI Overview**](./wiki/GUI-Overview.md)
46-
1. [**Subscription Handling**](./wiki/Subscription-Handling.md)
47-
- [**Add Subscription**](./wiki/Add-Subscription.md)
48-
1. [**Test Rules User Guide**](./wiki/Test-Rules.md)
45+
1. [**GUI Overview**](./wiki/markdown/GUI-Overview.md)
46+
1. [**Subscription Handling**](./wiki/markdown/Subscription-Handling.md)
47+
- [**Add Subscription**](./wiki/markdown/Add-Subscription.md)
48+
1. [**Test Rules User Guide**](./wiki/markdown/Test-Rules.md)

‎docs/Add-Subscription.html

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
<!DOCTYPE html>
2+
<!--
3+
| Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-12-11
4+
| Rendered using Apache Maven Fluido Skin 1.5
5+
-->
6+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7+
<head>
8+
<meta charset="UTF-8" />
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
10+
<meta name="Date-Revision-yyyymmdd" content="20181211" />
11+
<meta http-equiv="Content-Language" content="en" />
12+
<title>Eiffel Intelligence Frontend &#x2013; Add Subscription</title>
13+
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
14+
<link rel="stylesheet" href="./css/site.css" />
15+
<link rel="stylesheet" href="./css/print.css" media="print" />
16+
17+
18+
<script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
19+
20+
21+
</head>
22+
<body class="topBarEnabled">
23+
24+
25+
26+
27+
28+
<div id="topbar" class="navbar navbar-fixed-top navbar-inverse">
29+
<div class="navbar-inner">
30+
<div class="container-fluid">
31+
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</a>
36+
37+
<a class="brand" href="./" >
38+
39+
40+
Eiffel Intelligence Frontend
41+
42+
</a>
43+
44+
<ul class="nav">
45+
<li class="dropdown">
46+
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
47+
<ul class="dropdown-menu">
48+
49+
<li> <a href="index.html" title="Home">Home</a>
50+
</li>
51+
52+
<li> <a href="Add-Subscription.html" title="Add Subscription">Add Subscription</a>
53+
</li>
54+
55+
<li> <a href="GUI-Overview.html" title="GUI overview">GUI overview</a>
56+
</li>
57+
58+
<li> <a href="Subscription-Handling.html" title="Subscription handling">Subscription handling</a>
59+
</li>
60+
61+
<li> <a href="Test-Rules.html" title="Test rules">Test rules</a>
62+
</li>
63+
</ul>
64+
</li>
65+
</ul>
66+
67+
68+
69+
70+
</div>
71+
72+
</div>
73+
</div>
74+
</div>
75+
76+
<div class="container-fluid">
77+
<div id="banner">
78+
<div class="pull-left">
79+
<div id="bannerLeft">
80+
<h2>Eiffel Intelligence Frontend</h2>
81+
</div>
82+
</div>
83+
<div class="pull-right"> </div>
84+
<div class="clear"><hr/></div>
85+
</div>
86+
87+
<div id="breadcrumbs">
88+
<ul class="breadcrumb">
89+
90+
<li class="">
91+
<a href="index.html" title="Home">
92+
Home</a>
93+
<span class="divider">-</span>
94+
</li>
95+
<li class="active ">Add Subscription</li>
96+
97+
98+
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-12-11</li>
99+
<li id="projectVersion" class="pull-right">
100+
Version: 0.0.18
101+
</li>
102+
103+
</ul>
104+
</div>
105+
106+
107+
<div class="row-fluid">
108+
<div id="leftColumn" class="span3">
109+
<div class="well sidebar-nav">
110+
111+
<ul class="nav nav-list">
112+
<li class="nav-header">Overview</li>
113+
114+
<li>
115+
116+
<a href="index.html" title="Home">
117+
<span class="none"></span>
118+
Home</a>
119+
</li>
120+
121+
<li class="active">
122+
123+
<a href="#"><span class="none"></span>Add Subscription</a>
124+
</li>
125+
126+
<li>
127+
128+
<a href="GUI-Overview.html" title="GUI overview">
129+
<span class="none"></span>
130+
GUI overview</a>
131+
</li>
132+
133+
<li>
134+
135+
<a href="Subscription-Handling.html" title="Subscription handling">
136+
<span class="none"></span>
137+
Subscription handling</a>
138+
</li>
139+
140+
<li>
141+
142+
<a href="Test-Rules.html" title="Test rules">
143+
<span class="none"></span>
144+
Test rules</a>
145+
</li>
146+
</ul>
147+
148+
149+
<hr />
150+
151+
<div id="poweredBy">
152+
<div class="clear"></div>
153+
<div class="clear"></div>
154+
<div class="clear"></div>
155+
<div class="clear"></div>
156+
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
157+
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
158+
</a>
159+
</div>
160+
</div>
161+
</div>
162+
163+
164+
<div id="bodyColumn" class="span9" >
165+
166+
<h1>Add Subscription</h1>
167+
<p>This form is used to add subscription through frontend GUI. Here is a description of the elements available on this form.</p>
168+
<p><b>Load Subscription Template:</b> 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.</p>
169+
<p><b>SubscriptionName:</b> A field to give a name to the current subscription. Only letters, underscore and numbers are allowed in this field.</p>
170+
<p><b>NotificationType:</b> There are two options: REST POST and Mail Trigger, depending on how a subscriber want to be notified when a subscription is fulfilled. If Notification type MAIL is selected an email subject may be entered, but it is optional.</p>
171+
<p><b>RestPostMediaType:</b> Options for selecting a specific form content type. The options available in the list depends on the selected template type.</p>
172+
<p><b>NotificationMessage:</b> 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, &#x201c;Add Key/Value pair&#x201d;, in this field may be used to add more messages.</p>
173+
<p><b>Authorization:</b> A list to select authorization type. Currently, only one authorization type is provided which is &#x201c;BASIC_AUTH&#x201d;. The option &#x201c;NO_AUTH&#x201d; implies that authorization is not required.</p>
174+
<p><b>Repeat:</b> It is possible to enable repeat, e.g. whether same subscription should be re-triggered for new additions to the aggregated object. If disabled, the notification will be triggered only the first time when conditions are fulfilled.</p>
175+
<p><b>Requirement:</b> 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 &#x201c;Add Condition&#x201d; button. It should be noted that conditions under one requirement are connected by logical &#x201c;AND&#x201d;. Thus all conditions udder one requirement need to be satisfied before a subscription is triggered. More than one requirements may be added by &#x201c;Add Requirement&#x201d; button. Requirements are connected by logical &#x201c;OR&#x201d;.</p>
176+
</div>
177+
</div>
178+
</div>
179+
180+
<hr/>
181+
182+
<footer>
183+
<div class="container-fluid">
184+
<div class="row-fluid">
185+
186+
</div>
187+
188+
189+
</div>
190+
</footer>
191+
</body>
192+
</html>

‎docs/GUI-Overview.html

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
<!DOCTYPE html>
2+
<!--
3+
| Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-12-11
4+
| Rendered using Apache Maven Fluido Skin 1.5
5+
-->
6+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7+
<head>
8+
<meta charset="UTF-8" />
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
10+
<meta name="Date-Revision-yyyymmdd" content="20181211" />
11+
<meta http-equiv="Content-Language" content="en" />
12+
<title>Eiffel Intelligence Frontend &#x2013; GUI Overview</title>
13+
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
14+
<link rel="stylesheet" href="./css/site.css" />
15+
<link rel="stylesheet" href="./css/print.css" media="print" />
16+
17+
18+
<script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
19+
20+
21+
</head>
22+
<body class="topBarEnabled">
23+
24+
25+
26+
27+
28+
<div id="topbar" class="navbar navbar-fixed-top navbar-inverse">
29+
<div class="navbar-inner">
30+
<div class="container-fluid">
31+
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</a>
36+
37+
<a class="brand" href="./" >
38+
39+
40+
Eiffel Intelligence Frontend
41+
42+
</a>
43+
44+
<ul class="nav">
45+
<li class="dropdown">
46+
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
47+
<ul class="dropdown-menu">
48+
49+
<li> <a href="index.html" title="Home">Home</a>
50+
</li>
51+
52+
<li> <a href="Add-Subscription.html" title="Add Subscription">Add Subscription</a>
53+
</li>
54+
55+
<li> <a href="GUI-Overview.html" title="GUI overview">GUI overview</a>
56+
</li>
57+
58+
<li> <a href="Subscription-Handling.html" title="Subscription handling">Subscription handling</a>
59+
</li>
60+
61+
<li> <a href="Test-Rules.html" title="Test rules">Test rules</a>
62+
</li>
63+
</ul>
64+
</li>
65+
</ul>
66+
67+
68+
69+
70+
</div>
71+
72+
</div>
73+
</div>
74+
</div>
75+
76+
<div class="container-fluid">
77+
<div id="banner">
78+
<div class="pull-left">
79+
<div id="bannerLeft">
80+
<h2>Eiffel Intelligence Frontend</h2>
81+
</div>
82+
</div>
83+
<div class="pull-right"> </div>
84+
<div class="clear"><hr/></div>
85+
</div>
86+
87+
<div id="breadcrumbs">
88+
<ul class="breadcrumb">
89+
90+
<li class="">
91+
<a href="index.html" title="Home">
92+
Home</a>
93+
<span class="divider">-</span>
94+
</li>
95+
<li class="active ">GUI Overview</li>
96+
97+
98+
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2018-12-11</li>
99+
<li id="projectVersion" class="pull-right">
100+
Version: 0.0.18
101+
</li>
102+
103+
</ul>
104+
</div>
105+
106+
107+
<div class="row-fluid">
108+
<div id="leftColumn" class="span3">
109+
<div class="well sidebar-nav">
110+
111+
<ul class="nav nav-list">
112+
<li class="nav-header">Overview</li>
113+
114+
<li>
115+
116+
<a href="index.html" title="Home">
117+
<span class="none"></span>
118+
Home</a>
119+
</li>
120+
121+
<li>
122+
123+
<a href="Add-Subscription.html" title="Add Subscription">
124+
<span class="none"></span>
125+
Add Subscription</a>
126+
</li>
127+
128+
<li class="active">
129+
130+
<a href="#"><span class="none"></span>GUI overview</a>
131+
</li>
132+
133+
<li>
134+
135+
<a href="Subscription-Handling.html" title="Subscription handling">
136+
<span class="none"></span>
137+
Subscription handling</a>
138+
</li>
139+
140+
<li>
141+
142+
<a href="Test-Rules.html" title="Test rules">
143+
<span class="none"></span>
144+
Test rules</a>
145+
</li>
146+
</ul>
147+
148+
149+
<hr />
150+
151+
<div id="poweredBy">
152+
<div class="clear"></div>
153+
<div class="clear"></div>
154+
<div class="clear"></div>
155+
<div class="clear"></div>
156+
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
157+
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
158+
</a>
159+
</div>
160+
</div>
161+
</div>
162+
163+
164+
<div id="bodyColumn" class="span9" >
165+
166+
<h1>GUI Overview</h1>
167+
<p>Eiffel Intelligence Frontend GUI can be divided into two parts a navigation window and a work window.</p>
168+
<img src="../images/GUI_subscription_example.png" alt="" />
169+
</img>
170+
171+
<p>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.</p>
172+
<p>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.</p>
173+
</div>
174+
</div>
175+
</div>
176+
177+
<hr/>
178+
179+
<footer>
180+
<div class="container-fluid">
181+
<div class="row-fluid">
182+
183+
</div>
184+
185+
186+
</div>
187+
</footer>
188+
</body>
189+
</html>

0 commit comments

Comments
 (0)