Skip to content

Commit b908249

Browse files
authored
Update of add-subsciption documentations and some Readme links. (#249)
1 parent 79f1fce commit b908249

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
5151
# Documentation
5252

5353
1. [**Introduction**](./wiki/markdown/index.md)
54-
1. [**Run in Docker**](./wiki/markdown/docker.md)
54+
1. [**Running Eiffel-Intelligence frontend**](./wiki/markdown/running-eiffel-intelligence-frontend.md)
55+
- [**Run in Docker**](./wiki/markdown/docker.md)
56+
- [**Configuration**](./wiki/markdown/configuration.md)
5557
1. [**GUI Overview**](./wiki/markdown/GUI-overview.md)
5658
1. [**Subscription Handling**](./wiki/markdown/subscription-handling.md)
5759
- [**Add Subscription**](./wiki/markdown/add-subscription.md)

wiki/markdown/add-subscription.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,40 @@ description of the elements available on this form.
77
<img style="border:1px solid black" src="images/subscription_add_part1.png"></img>
88
</kbd>
99

10-
**Load Subscription Template:** In this dropdown list, options are given to
10+
## Load Subscription Template
11+
In this dropdown list, options are given to
1112
select a specific template for the subscription form. Currently, the following
1213
options are listed: Jenkins Pipeline Parametrized Job Trigger, REST POST and
1314
Mail Trigger.
1415

15-
**SubscriptionName:** A field to give a name to the current subscription. Only
16+
## SubscriptionName
17+
A field to give a name to the current subscription. Only
1618
letters, underscore and numbers are allowed in this field.
1719

1820
<kbd>
1921
<img style="border:1px solid black" src="images/subscription_add_part2.png"></img>
2022
</kbd>
2123

22-
**NotificationType:** There are two options: REST POST and
24+
## NotificationType
25+
There are two options: REST POST and
2326
Mail Trigger, depending on how a subscriber want to be notified when a
2427
subscription is fulfilled. If Notification type MAIL is selected an email
2528
subject may be entered, but it is optional.
2629

27-
**RestPostMediaType:** Options for selecting a
30+
## RestPostMediaType
31+
Options for selecting a
2832
specific form content type. The options available in the list depends on the
2933
selected template type.
3034

31-
**NotificationMessage:** It is used to send a message to a specific client. The
35+
## NotificationMessage
36+
It is used to send a message to a specific client. The
3237
format of the message depends on the options selected in the NotificationMessage
3338
and RestPostMediaType. A button, “Add Key/Value pair”, in this field may be
3439
used to add more messages, if the selected RestPostBodyMediaType is FORM/POST
3540
parameters.
3641

37-
**NotificationMeta:** Is the selected subscriber to notify when a subscription
42+
## NotificationMeta
43+
Is the selected subscriber to notify when a subscription
3844
is triggered. It could be an email address such as `example@mail.com` or a url
3945
like `host.com/endpoint`. If you wish to trigger Jenkins job when a subscription
4046
is fulfilled then the url for the job could be set as the notificationMeta.
@@ -46,10 +52,11 @@ used as a password for authentication against the entire jenkins instance.
4652
<img style="border:1px solid black" src="images/subscription_add_part3.png"></img>
4753
</kbd>
4854

49-
**Authentication:** A list to select authentication type.
55+
## Authentication
56+
A list to select authentication type.
5057
* NO_AUTH: _No Authentication used_
5158
* BASIC_AUTH: _Username and password will be Base 64 encoded_
52-
* BASIC_AUTH Jenkins CSRF Protection (crumb): _Username and password will
59+
* BASIC_AUTH_JENKINS_CSRF: Jenkins CSRF Protection (crumb), _Username and password will
5360
be Base 64 encoded. A crumb will be fetched automatically before request is made.
5461
(Currently default in many Jenkins instances). **Note**: Will work even when CSRF
5562
is disabled in Jenkins._
@@ -58,12 +65,14 @@ is disabled in Jenkins._
5865
<img style="border:1px solid black" src="images/subscription_add_part4.png"></img>
5966
</kbd>
6067

61-
**Repeat:** It is possible to enable repeat, e.g. whether same subscription
68+
## Repeat
69+
It is possible to enable repeat, e.g. whether same subscription
6270
should be re-triggered for new additions to the aggregated object. If disabled,
6371
the notification will be triggered only the first time when requirements are
6472
fulfilled. It doesn't matter if you have multiple requirements, it will only be triggered once.
6573

66-
**Requirement and Conditions:** It is used to add a requirement, which need to
74+
## Requirement and Conditions
75+
It is used to add a requirement, which need to
6776
be fulfilled before a subscription is triggered. Requirement is added in the form
6877
of a condition (with a specific format). More than one conditions may be added
6978
under one requirement by using “Add Condition” button. It should be noted

0 commit comments

Comments
 (0)