-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #450 from OP-TED/feature/update-antora
updated documentation
- Loading branch information
Showing
21 changed files
with
19,411 additions
and
2,347 deletions.
There are no files selected for viewing
17,158 changes: 17,158 additions & 0 deletions
17,158
docs/antora/modules/ROOT/attachments/FATs/2023-02-20-TED-SWS-FAT-complete.html
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes.
Binary file added
BIN
+701 KB
docs/antora/modules/ROOT/attachments/aws-infra-docs/TED-SWS-Installation-manual-v2.5.0.pdf
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,30 @@ | ||
|
||
* xref:index.adoc[Home] | ||
* link:{attachmentsdir}/ted-sws-architecture/index.html[Preliminary Project Architecture^] | ||
* xref:mapping_suite_cli_toolchain.adoc[Mapping Suite CLI Toolchain] | ||
* xref:demo_installation.adoc[Instructions for Software Engineers] | ||
* xref:user_manual.adoc[User manual] | ||
* xref:system_arhitecture.adoc[System architecture overview] | ||
* xref:using_procurement_data.adoc[Using procurement data] | ||
* [.separated]#**General References**# | ||
** xref:ted-sws-introduction.adoc[About TED-SWS] | ||
** xref:glossary.adoc[Glossary] | ||
* [.separated]#**For TED-SWS Operators**# | ||
** xref:user_manual/getting_started_user_manual.adoc[Getting started] | ||
** xref:user_manual/system-overview.adoc[System overview] | ||
** xref:user_manual/access-security.adoc[Security and access] | ||
** xref:user_manual/workflow-management-airflow.adoc[Workflow management with Airflow] | ||
** xref:user_manual/system-monitoring-metabase.adoc[System monitoring with Metabase] | ||
* [.separated]#**For DevOps**# | ||
** link:{attachmentsdir}/aws-infra-docs/TED-SWS-Installation-manual-v2.5.0.pdf[AWS installation manual (v2.5.0)^] | ||
** link:{attachmentsdir}/aws-infra-docs/TED-SWS-AWS-Infrastructure-architecture-overview-v0.9.pdf[AWS infrastructure architecture (v0.9)^] | ||
|
||
* [.separated]#**For End User Developers**# | ||
** xref:ted_data/using_procurement_data.adoc[Accessing data in Cellar] | ||
** link:https://docs.ted.europa.eu/EPO/latest/index.html[eProcurement ontology (latest)^] | ||
* [.separated]#**For TED-SWS Developers**# | ||
** xref:technical/mapping_suite_cli_toolchain.adoc[Mapping suite toolchain] | ||
** xref:technical/demo_installation.adoc[Development installation instructions] | ||
** xref:technical/event_manager.adoc[Event manager description] | ||
** xref:architecture/arhitecture_choices.adoc[System architecture overview] | ||
** link:{attachmentsdir}/ted-sws-architecture/index.html[Enterprise architecture model^] | ||
** xref:architecture/arhitecture_choices.adoc[Architectural choices] |
351 changes: 351 additions & 0 deletions
351
docs/antora/modules/ROOT/pages/architecture/arhitecture_choices.adoc
Large diffs are not rendered by default.
Oops, something went wrong.
476 changes: 476 additions & 0 deletions
476
docs/antora/modules/ROOT/pages/architecture/arhitecture_overview.adoc
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
== Future work | ||
|
||
In the future, another Master Data Registry type system will be used to | ||
deduplicate entities in the TED-SWS system, which will be implemented | ||
according to the requirements for deduplication of entities from | ||
notices. | ||
|
||
The future Master Data Registry (MDR) system for entity deduplication | ||
should have the following architecture: | ||
|
||
[arabic] | ||
. *Data Ingestion*: This component is responsible for extracting and | ||
collecting data from various sources, such as databases, files, and | ||
APIs. The data is then transformed, cleaned, and consolidated into a | ||
single format before it is loaded into the MDR. | ||
|
||
. *Data Quality*: This component is responsible for enforcing data quality | ||
rules, such as format, completeness, and consistency, on the data before | ||
it is entered into the MDR. This can include tasks such as data | ||
validation, data standardization, and data cleansing. | ||
|
||
. *Entity Dedup*: This component is responsible for identifying and | ||
removing duplicate entities in the MDR. This can be done using a | ||
combination of techniques such as string-based, machine learning-based, | ||
or knowledge-based methods. | ||
|
||
. *Data Governance*: This component is responsible for ensuring that the | ||
data in the MDR is accurate, complete, and up-to-date. This can include | ||
processes for data validation, data reconciliation, and data | ||
maintenance. | ||
|
||
. *Data Access and Integration*: This component provides access to the MDR | ||
data through a user interface and API's, and integrates the MDR data | ||
with other systems and applications. | ||
|
||
. *Data Security*: This component is responsible for ensuring that the | ||
data in the MDR is secure, and that only authorized users can access it. | ||
This can include tasks such as authentication, access control, and | ||
encryption. | ||
|
||
. *Data Management*: This component is responsible for managing the data | ||
in the MDR, including tasks such as data archiving, data backup, and | ||
data recovery. | ||
|
||
. *Monitoring and Analytics*: This component is responsible for monitoring | ||
and analysing the performance of the MDR system, and for providing | ||
insights into the data to help improve the system. | ||
|
||
. *Services layer*: This component is responsible for providing services | ||
such as, indexing, search and query functionalities over the data. | ||
|
||
|
||
All these components should be integrated and work together to provide a | ||
comprehensive and efficient MDR system for entity deduplication. The | ||
system should be scalable and flexible enough to handle large amounts of | ||
data and adapt to changing business requirements. | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
== Glossary | ||
|
||
*Airflow* - an open-source platform for developing, scheduling, and | ||
monitoring batch-oriented pipelines. The web interface helps manage the | ||
state and monitoring of your pipelines. | ||
|
||
*Metabase* - is the BI tool with the friendly UX and integrated tooling | ||
to let you explore data gathered by running the pipelines available in | ||
Airflow. | ||
|
||
*Cellar* - is the central content and metadata repository of the | ||
Publications Office of the European Union | ||
|
||
*TED-SWS* - is a pipeline system that continuously converts the public | ||
procurement notices (in XML format) available on the TED Website into | ||
RDF format and publishes them into CELLAR | ||
|
||
*DAG* - (Directed Acyclic Graph) is the core concept of Airflow, | ||
collecting Tasks together, organized with dependencies and relationships | ||
to say how they should run. The DAGS are basically the pipelines that | ||
run in this project to get the public procurement notices from XML to | ||
RDF and to be published them into CELLAR. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.