Skip to content

Commit

Permalink
[docs] Updated docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Alessandro Tundo <alessandrotundo94@gmail.com>
  • Loading branch information
@aletundo
aletundo committed Jul 17, 2018
1 parent 1a79474 commit e865960
Show file tree
Hide file tree
Showing 419 changed files with 965 additions and 1,053 deletions.
4 changes: 2 additions & 2 deletions docs/architecture_overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ It also exposes a RESTful API and publishes/consumes notable events to/from Kafk

Analyses executor service
"""""""""""""""""""""""""
The analyses-executor-service is a `SpringBoot-based <https://projects.spring.io/spring-boot/>`_ microservice. It encapsulates the logic to manage analysis scheduling and execution.
The analyses-executor-service is a `SpringBoot-based <https://projects.spring.io/spring-boot/>`_ microservice that relies on a `MongoDB <https://www.mongodb.com/>`_ storage engine. It encapsulates the logic to manage analysis scheduling and execution.
Moreover, it also exposes a RESTful API and publishes/consumes notable events to/from Kafka.

Notifications service
"""""""""""""""""""""
The analyses-executor-service is a `SpringBoot-based <https://projects.spring.io/spring-boot/>`_ microservice that actually relies on a `MariaDB <https://mariadb.org/>`_ storage engine. It encapsulates the logic to manage and send notifications.
The analyses-executor-service is a `SpringBoot-based <https://projects.spring.io/spring-boot/>`_ microservice that relies on a `MongoDB <https://www.mongodb.com/>`_ storage engine. It encapsulates the logic to manage and send notifications.
It also exposes a RESTful API and publishes and consumes notable events to/from Kafka.

Projects service
Expand Down
Binary file modified docs/images/Components.jpg
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 2 additions & 10 deletions docs/javadoc/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun Jul 15 21:04:52 CEST 2018 -->
<!-- Generated by javadoc (1.8.0_172) on Tue Jul 17 22:31:50 CEST 2018 -->
<title>All Classes</title>
<meta name="date" content="2018-07-15">
<meta name="date" content="2018-07-17">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -13,9 +13,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/AnalysesConfiguratorServiceApplication.html" title="class in it.unimib.disco.aras.analysesconfiguratorservice" target="classFrame">AnalysesConfiguratorServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/AnalysesConfiguratorServiceApplicationTests.html" title="class in it.unimib.disco.aras.analysesconfiguratorservice" target="classFrame">AnalysesConfiguratorServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/AnalysesExecutorServiceApplication.html" title="class in it.unimib.disco.aras.analysesexecutorservice" target="classFrame">AnalysesExecutorServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/AnalysesExecutorServiceApplicationTests.html" title="class in it.unimib.disco.aras.analysesexecutorservice" target="classFrame">AnalysesExecutorServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/stream/AnalysesStream.html" title="interface in it.unimib.disco.aras.analysesexecutorservice.stream" target="classFrame"><span class="interfaceName">AnalysesStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/AnalysesStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream" target="classFrame"><span class="interfaceName">AnalysesStream</span></a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/entity/Analysis.html" title="class in it.unimib.disco.aras.analysesexecutorservice.entity" target="classFrame">Analysis</a></li>
Expand Down Expand Up @@ -53,7 +51,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/service/ArtefactsDownloadService.html" title="class in it.unimib.disco.aras.analysesexecutorservice.service" target="classFrame">ArtefactsDownloadService</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/service/ArtefactStorageService.html" title="class in it.unimib.disco.aras.projectsservice.service" target="classFrame">ArtefactStorageService</a></li>
<li><a href="it/unimib/disco/aras/configserver/ConfigServerApplication.html" title="class in it.unimib.disco.aras.configserver" target="classFrame">ConfigServerApplication</a></li>
<li><a href="it/unimib/disco/aras/configserver/ConfigServerApplicationTests.html" title="class in it.unimib.disco.aras.configserver" target="classFrame">ConfigServerApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.analysesexecutorservice.stream.consumer" target="classFrame"><span class="interfaceName">Consumer</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.notificationsservice.stream.consumer" target="classFrame"><span class="interfaceName">Consumer</span></a></li>
<li><a href="it/unimib/disco/aras/reportsservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.reportsservice.stream.consumer" target="classFrame"><span class="interfaceName">Consumer</span></a></li>
Expand All @@ -69,15 +66,12 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/reportsservice/config/DiscoveryClientConfiguration.html" title="class in it.unimib.disco.aras.reportsservice.config" target="classFrame">DiscoveryClientConfiguration</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/service/EmailService.html" title="class in it.unimib.disco.aras.notificationsservice.service" target="classFrame">EmailService</a></li>
<li><a href="it/unimib/disco/aras/eurekaserver/EurekaServerApplication.html" title="class in it.unimib.disco.aras.eurekaserver" target="classFrame">EurekaServerApplication</a></li>
<li><a href="it/unimib/disco/aras/eurekaserver/EurekaServerApplicationTests.html" title="class in it.unimib.disco.aras.eurekaserver" target="classFrame">EurekaServerApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/gateway/GatewayApplication.html" title="class in it.unimib.disco.aras.gateway" target="classFrame">GatewayApplication</a></li>
<li><a href="it/unimib/disco/aras/gateway/GatewayApplicationTests.html" title="class in it.unimib.disco.aras.gateway" target="classFrame">GatewayApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/entity/Notification.html" title="class in it.unimib.disco.aras.notificationsservice.entity" target="classFrame">Notification</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/NotificationMessage.html" title="class in it.unimib.disco.aras.notificationsservice.stream.message" target="classFrame">NotificationMessage</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/producer/NotificationProducerImpl.html" title="class in it.unimib.disco.aras.notificationsservice.stream.producer" target="classFrame">NotificationProducerImpl</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/service/NotificationService.html" title="class in it.unimib.disco.aras.notificationsservice.service" target="classFrame">NotificationService</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/NotificationsServiceApplication.html" title="class in it.unimib.disco.aras.notificationsservice" target="classFrame">NotificationsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/NotificationsServiceApplicationTests.html" title="class in it.unimib.disco.aras.notificationsservice" target="classFrame">NotificationsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/NotificationsStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream" target="classFrame"><span class="interfaceName">NotificationsStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/entity/NotificationType.html" title="enum in it.unimib.disco.aras.notificationsservice.entity" target="classFrame">NotificationType</a></li>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/stream/producer/Producer.html" title="interface in it.unimib.disco.aras.analysesconfiguratorservice.stream.producer" target="classFrame"><span class="interfaceName">Producer</span></a></li>
Expand All @@ -89,7 +83,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/projectsservice/repository/ProjectEventHandler.html" title="class in it.unimib.disco.aras.projectsservice.repository" target="classFrame">ProjectEventHandler</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/repository/ProjectRepository.html" title="interface in it.unimib.disco.aras.projectsservice.repository" target="classFrame"><span class="interfaceName">ProjectRepository</span></a></li>
<li><a href="it/unimib/disco/aras/projectsservice/ProjectsServiceApplication.html" title="class in it.unimib.disco.aras.projectsservice" target="classFrame">ProjectsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/ProjectsServiceApplicationTests.html" title="class in it.unimib.disco.aras.projectsservice" target="classFrame">ProjectsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/entity/Report.html" title="class in it.unimib.disco.aras.reportsservice.entity" target="classFrame">Report</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/web/rest/ReportDownloadController.html" title="class in it.unimib.disco.aras.reportsservice.web.rest" target="classFrame">ReportDownloadController</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/ReportMessage.html" title="class in it.unimib.disco.aras.notificationsservice.stream.message" target="classFrame">ReportMessage</a></li>
Expand All @@ -102,7 +95,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/notificationsservice/service/ReportsDownloadService.html" title="class in it.unimib.disco.aras.notificationsservice.service" target="classFrame">ReportsDownloadService</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/service/ReportService.html" title="class in it.unimib.disco.aras.reportsservice.service" target="classFrame">ReportService</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/ReportsServiceApplication.html" title="class in it.unimib.disco.aras.reportsservice" target="classFrame">ReportsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/ReportsServiceApplicationTests.html" title="class in it.unimib.disco.aras.reportsservice" target="classFrame">ReportsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/ReportsStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream" target="classFrame"><span class="interfaceName">ReportsStream</span></a></li>
<li><a href="it/unimib/disco/aras/reportsservice/stream/ReportsStream.html" title="interface in it.unimib.disco.aras.reportsservice.stream" target="classFrame"><span class="interfaceName">ReportsStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/ReportStatus.html" title="enum in it.unimib.disco.aras.notificationsservice.stream.message" target="classFrame">ReportStatus</a></li>
Expand Down
12 changes: 2 additions & 10 deletions docs/javadoc/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun Jul 15 21:04:52 CEST 2018 -->
<!-- Generated by javadoc (1.8.0_172) on Tue Jul 17 22:31:50 CEST 2018 -->
<title>All Classes</title>
<meta name="date" content="2018-07-15">
<meta name="date" content="2018-07-17">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -13,9 +13,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/AnalysesConfiguratorServiceApplication.html" title="class in it.unimib.disco.aras.analysesconfiguratorservice">AnalysesConfiguratorServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/AnalysesConfiguratorServiceApplicationTests.html" title="class in it.unimib.disco.aras.analysesconfiguratorservice">AnalysesConfiguratorServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/AnalysesExecutorServiceApplication.html" title="class in it.unimib.disco.aras.analysesexecutorservice">AnalysesExecutorServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/AnalysesExecutorServiceApplicationTests.html" title="class in it.unimib.disco.aras.analysesexecutorservice">AnalysesExecutorServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/stream/AnalysesStream.html" title="interface in it.unimib.disco.aras.analysesexecutorservice.stream"><span class="interfaceName">AnalysesStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/AnalysesStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream"><span class="interfaceName">AnalysesStream</span></a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/entity/Analysis.html" title="class in it.unimib.disco.aras.analysesexecutorservice.entity">Analysis</a></li>
Expand Down Expand Up @@ -53,7 +51,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/service/ArtefactsDownloadService.html" title="class in it.unimib.disco.aras.analysesexecutorservice.service">ArtefactsDownloadService</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/service/ArtefactStorageService.html" title="class in it.unimib.disco.aras.projectsservice.service">ArtefactStorageService</a></li>
<li><a href="it/unimib/disco/aras/configserver/ConfigServerApplication.html" title="class in it.unimib.disco.aras.configserver">ConfigServerApplication</a></li>
<li><a href="it/unimib/disco/aras/configserver/ConfigServerApplicationTests.html" title="class in it.unimib.disco.aras.configserver">ConfigServerApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/analysesexecutorservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.analysesexecutorservice.stream.consumer"><span class="interfaceName">Consumer</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.notificationsservice.stream.consumer"><span class="interfaceName">Consumer</span></a></li>
<li><a href="it/unimib/disco/aras/reportsservice/stream/consumer/Consumer.html" title="interface in it.unimib.disco.aras.reportsservice.stream.consumer"><span class="interfaceName">Consumer</span></a></li>
Expand All @@ -69,15 +66,12 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/reportsservice/config/DiscoveryClientConfiguration.html" title="class in it.unimib.disco.aras.reportsservice.config">DiscoveryClientConfiguration</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/service/EmailService.html" title="class in it.unimib.disco.aras.notificationsservice.service">EmailService</a></li>
<li><a href="it/unimib/disco/aras/eurekaserver/EurekaServerApplication.html" title="class in it.unimib.disco.aras.eurekaserver">EurekaServerApplication</a></li>
<li><a href="it/unimib/disco/aras/eurekaserver/EurekaServerApplicationTests.html" title="class in it.unimib.disco.aras.eurekaserver">EurekaServerApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/gateway/GatewayApplication.html" title="class in it.unimib.disco.aras.gateway">GatewayApplication</a></li>
<li><a href="it/unimib/disco/aras/gateway/GatewayApplicationTests.html" title="class in it.unimib.disco.aras.gateway">GatewayApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/entity/Notification.html" title="class in it.unimib.disco.aras.notificationsservice.entity">Notification</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/NotificationMessage.html" title="class in it.unimib.disco.aras.notificationsservice.stream.message">NotificationMessage</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/producer/NotificationProducerImpl.html" title="class in it.unimib.disco.aras.notificationsservice.stream.producer">NotificationProducerImpl</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/service/NotificationService.html" title="class in it.unimib.disco.aras.notificationsservice.service">NotificationService</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/NotificationsServiceApplication.html" title="class in it.unimib.disco.aras.notificationsservice">NotificationsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/NotificationsServiceApplicationTests.html" title="class in it.unimib.disco.aras.notificationsservice">NotificationsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/NotificationsStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream"><span class="interfaceName">NotificationsStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/entity/NotificationType.html" title="enum in it.unimib.disco.aras.notificationsservice.entity">NotificationType</a></li>
<li><a href="it/unimib/disco/aras/analysesconfiguratorservice/stream/producer/Producer.html" title="interface in it.unimib.disco.aras.analysesconfiguratorservice.stream.producer"><span class="interfaceName">Producer</span></a></li>
Expand All @@ -89,7 +83,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/projectsservice/repository/ProjectEventHandler.html" title="class in it.unimib.disco.aras.projectsservice.repository">ProjectEventHandler</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/repository/ProjectRepository.html" title="interface in it.unimib.disco.aras.projectsservice.repository"><span class="interfaceName">ProjectRepository</span></a></li>
<li><a href="it/unimib/disco/aras/projectsservice/ProjectsServiceApplication.html" title="class in it.unimib.disco.aras.projectsservice">ProjectsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/projectsservice/ProjectsServiceApplicationTests.html" title="class in it.unimib.disco.aras.projectsservice">ProjectsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/entity/Report.html" title="class in it.unimib.disco.aras.reportsservice.entity">Report</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/web/rest/ReportDownloadController.html" title="class in it.unimib.disco.aras.reportsservice.web.rest">ReportDownloadController</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/ReportMessage.html" title="class in it.unimib.disco.aras.notificationsservice.stream.message">ReportMessage</a></li>
Expand All @@ -102,7 +95,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="it/unimib/disco/aras/notificationsservice/service/ReportsDownloadService.html" title="class in it.unimib.disco.aras.notificationsservice.service">ReportsDownloadService</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/service/ReportService.html" title="class in it.unimib.disco.aras.reportsservice.service">ReportService</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/ReportsServiceApplication.html" title="class in it.unimib.disco.aras.reportsservice">ReportsServiceApplication</a></li>
<li><a href="it/unimib/disco/aras/reportsservice/ReportsServiceApplicationTests.html" title="class in it.unimib.disco.aras.reportsservice">ReportsServiceApplicationTests</a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/ReportsStream.html" title="interface in it.unimib.disco.aras.notificationsservice.stream"><span class="interfaceName">ReportsStream</span></a></li>
<li><a href="it/unimib/disco/aras/reportsservice/stream/ReportsStream.html" title="interface in it.unimib.disco.aras.reportsservice.stream"><span class="interfaceName">ReportsStream</span></a></li>
<li><a href="it/unimib/disco/aras/notificationsservice/stream/message/ReportStatus.html" title="enum in it.unimib.disco.aras.notificationsservice.stream.message">ReportStatus</a></li>
Expand Down

0 comments on commit e865960

Please sign in to comment.