Skip to content

Commit 37e5606

Browse files
Remove mvn site and stop publishing docs to github-pages (#279)
* Change to relative links in documentation * Remove travis deploy job and remove mvn site plugin * Update application.properties for integrationtest * Fix tests to align with new property name
1 parent bddb824 commit 37e5606

Some content is hidden

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

45 files changed

+226
-344
lines changed

.remarkrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"plugins": [
3+
"remark-preset-lint-recommended",
4+
["remark-lint-list-item-indent", false]
5+
]
6+
}

.travis.yml

+1-19
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,12 @@ before_install:
2323
- export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-amd64
2424
- java -version
2525

26-
# Using default 'test' stage for our tests, and only running deploy stage
26+
# Using default 'test' stage for our tests, and only running report_coverage
2727
# (after merge) on master branch
2828
stages:
2929
- test
3030
- name: report_coverage
3131
if: branch = master AND type != pull_request
32-
- name: deploy
33-
if: branch = master AND type != pull_request
34-
35-
# Only used before integrationTests
36-
# Generate site documentation using mvn site plugin
37-
before_deploy:
38-
- rm -rf docs
39-
- mvn site -B
4032

4133
# List of jobs to run, tied to specific stages
4234
jobs:
@@ -75,16 +67,6 @@ jobs:
7567
after_script:
7668
- docker-compose -f src/main/docker/docker-compose.yml down
7769
- fuser -k ${EI_BACKEND_PORT}/tcp
78-
- stage: deploy
79-
name: deployGitHubPages
80-
before_install: skip # do not run again
81-
install: skip # do not run again
82-
script: skip # do not run default test scripts
83-
deploy:
84-
provider: pages
85-
skip_cleanup: true
86-
github-token: $GITHUB_TOKEN
87-
local_dir: docs/
8870
- stage: report_coverage
8971
name: report_coverage
9072
before_install: skip

README.md

+20-14
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323
[![](https://jitpack.io/v/eiffel-community/eiffel-intelligence-frontend.svg)](https://jitpack.io/#eiffel-community/eiffel-intelligence-frontend)
2424

2525
# Eiffel Intelligence Frontend
26-
Eiffel Intelligence Frontend is part of the [Eiffel Intelligence](https://github.com/eiffel-community/eiffel-intelligence) implementation of the [Eiffel Protocol](https://github.com/eiffel-community/eiffel). Eiffel Intelligence Frontend allows the configuration of subscription and aggregation rules in Eiffel Intelligence.
26+
Eiffel Intelligence Frontend is part of the [Eiffel Intelligence](https://github.com/eiffel-community/eiffel-intelligence)
27+
implementation of the [Eiffel Protocol](https://github.com/eiffel-community/eiffel).
28+
Eiffel Intelligence Frontend allows the configuration of subscription and aggregation rules in Eiffel Intelligence.
2729

2830
Potential future features for Eiffel Intelligence Frontend include:
2931
* Real time testing of aggregation models for new bounded contexts
@@ -36,28 +38,32 @@ Potential future features for Eiffel Intelligence Frontend include:
3638
* Firefox 60.2.0 or later
3739

3840
## Compatibility
39-
To see which versions of back-end and front-end that work together you can check the [Compatibility](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/compatibility.md) page.
41+
To see which versions of back-end and front-end that work together you can
42+
check the [Compatibility](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/compatibility.md) page.
4043

4144
## About this repository
4245
The contents of this repository are licensed under the [Apache License 2.0](./LICENSE).
4346

4447
To get involved, please see [Code of Conduct](./CODE_OF_CONDUCT.md) and [contribution guidelines](./CONTRIBUTING.md).
4548

4649
## About Eiffel
47-
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.
50+
This repository forms part of the Eiffel Community. Eiffel is a protocol for
51+
technology agnostic machine-to-machine communication in continuous integration
52+
and delivery pipelines, aimed at securing scalability, flexibility and
53+
traceability. Eiffel is based on the concept of decentralized real time
54+
messaging, both to drive the continuous integration and delivery system and
55+
to document it.
4856

4957
Visit [Eiffel Community](https://eiffel-community.github.io) to get started and get involved.
5058

5159
## Documentation
5260

53-
1. [**Introduction**](./wiki/markdown/index.md)
54-
1. [**Running Eiffel-Intelligence front-end**](./wiki/markdown/running-eiffel-intelligence-frontend.md)
55-
- [**Run in Docker**](./wiki/markdown/docker.md)
56-
- [**Configuration**](./wiki/markdown/configuration.md)
57-
1. [**GUI Overview**](./wiki/markdown/GUI-overview.md)
58-
1. [**Subscription Handling**](./wiki/markdown/subscription-handling.md)
59-
- [**Add Subscription**](./wiki/markdown/add-subscription.md)
60-
1. [**Test Rules User Guide**](./wiki/markdown/test-rules.md)
61-
1. [**CURL examples**](./wiki/markdown/curl-examples.md)
62-
63-
[**Eiffel Intelligence frontend documentation can be found here**](https://eiffel-community.github.io/eiffel-intelligence-frontend/)
61+
1. [**Introduction**](wiki/index.md)
62+
2. [**Running Eiffel-Intelligence front-end**](wiki/running-eiffel-intelligence-frontend.md)
63+
- [**Run in Docker**](wiki/docker.md)
64+
- [**Configuration**](wiki/configuration.md)
65+
3. [**GUI Overview**](wiki/GUI-overview.md)
66+
4. [**Subscription Handling**](wiki/subscription-handling.md)
67+
- [**Add Subscription**](wiki/add-subscription.md)
68+
5. [**Test Rules User Guide**](wiki/test-rules.md)
69+
6. [**CURL examples**](wiki/curl-examples.md)

pom.xml

-48
Original file line numberDiff line numberDiff line change
@@ -279,54 +279,6 @@
279279
</includes>
280280
</configuration>
281281
</plugin>
282-
283-
<plugin>
284-
<groupId>org.apache.maven.plugins</groupId>
285-
<artifactId>maven-site-plugin</artifactId>
286-
<version>3.7.1</version>
287-
<configuration>
288-
<!-- This is where site.xml is located -->
289-
<siteDirectory>${basedir}/wiki</siteDirectory>
290-
<!-- Github pages only generates documentation from docs
291-
directory -->
292-
<outputDirectory>${basedir}/docs</outputDirectory>
293-
</configuration>
294-
<dependencies>
295-
<dependency>
296-
<groupId>org.apache.maven.doxia</groupId>
297-
<artifactId>doxia-module-markdown</artifactId>
298-
<version>1.8</version>
299-
</dependency>
300-
</dependencies>
301-
</plugin>
302-
<plugin>
303-
<artifactId>maven-resources-plugin</artifactId>
304-
<version>3.1.0</version>
305-
<executions>
306-
<execution>
307-
<id>copy-resources</id>
308-
<!-- here the phase you need -->
309-
<phase>pre-site</phase>
310-
<goals>
311-
<goal>copy-resources</goal>
312-
</goals>
313-
<configuration>
314-
<!-- plugin requires all resources to exist within
315-
resources/ directory -->
316-
<!-- but we don't want to break links in documentation -->
317-
<outputDirectory>${basedir}/wiki/resources/images</outputDirectory>
318-
<resources>
319-
<resource>
320-
<directory>${basedir}/wiki/markdown/images</directory>
321-
<includes>
322-
<include>*.png</include>
323-
</includes>
324-
</resource>
325-
</resources>
326-
</configuration>
327-
</execution>
328-
</executions>
329-
</plugin>
330282
<plugin>
331283
<groupId>org.codehaus.mojo</groupId>
332284
<artifactId>cobertura-maven-plugin</artifactId>

src/integrationtest/resources/bodies/listRules.json

+8-24
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,15 @@
66
"IdRule": "meta.id",
77
"StartEvent": "YES",
88
"IdentifyRules": "[meta.id]",
9-
"MatchIdRules": {
10-
"_id": "%IdentifyRules_objid%"
11-
},
9+
"MatchIdRules": { "_id": "%IdentifyRulesEventId%" },
1210
"ExtractionRules": "{ id : meta.id, type : meta.type, time : meta.time, identity : data.identity, fileInformation : data.fileInformation, buildCommand : data.buildCommand }",
1311
"DownstreamIdentifyRules": "links | [?type=='COMPOSITION'].target",
14-
"DownstreamMergeRules": "{\"externalComposition\":{\"eventId\":%IdentifyRules%}}",
12+
"DownstreamMergeRules": "{\"externalComposition\":{\"eventId\":%IdentifyRulesEventId%}}",
1513
"DownstreamExtractionRules": "{artifacts: [{id : meta.id}]}",
16-
"ArrayMergeOptions": "",
1714
"HistoryIdentifyRules": "links | [?type=='COMPOSITION'].target",
1815
"HistoryExtractionRules": "{internalComposition:{artifacts: [{id : meta.id}]}}",
1916
"HistoryPathRules": "{artifacts: {id: meta.id}}",
20-
"ProcessRules": null,
21-
"ProcessFunction": null
17+
"ProcessRules": null
2218
},
2319
{
2420
"TemplateName": "ARTIFACT_TEST",
@@ -27,15 +23,9 @@
2723
"IdRule": "meta.id",
2824
"StartEvent": "NO",
2925
"IdentifyRules": "links | [?type=='ARTIFACT'].target",
30-
"MatchIdRules": {
31-
"_id": "%IdentifyRules_objid%"
32-
},
33-
"ExtractionRules": "{ publications :[ { eventId : meta.id, time : meta.time, locations : data.locations }] }",
34-
"ArrayMergeOptions": "",
35-
"HistoryIdentifyRules": "",
36-
"HistoryExtractionRules": "",
37-
"ProcessRules": null,
38-
"ProcessFunction": null
26+
"MatchIdRules": { "_id": "%IdentifyRulesEventId%" },
27+
"ExtractionRules": "{ publications :[{ eventId : meta.id, time : meta.time, locations : data.locations }] }",
28+
"ProcessRules": null
3929
},
4030
{
4131
"TemplateName": "ARTIFACT_TEST",
@@ -44,14 +34,8 @@
4434
"IdRule": "meta.id",
4535
"StartEvent": "NO",
4636
"IdentifyRules": "links | [?type=='SUBJECT'].target",
47-
"MatchIdRules": {
48-
"_id": "%IdentifyRules_objid%"
49-
},
37+
"MatchIdRules": { "_id": "%IdentifyRulesEventId%" },
5038
"ExtractionRules": "{confidenceLevels :[{ eventId:meta.id, time:meta.time, name:data.name, value:data.value}]}",
51-
"ArrayMergeOptions": "",
52-
"HistoryIdentifyRules": "",
53-
"HistoryExtractionRules": "",
54-
"ProcessRules": null,
55-
"ProcessFunction": null
39+
"ProcessRules": null
5640
}
5741
]

0 commit comments

Comments
 (0)