Skip to content

Commit

Permalink
Merge pull request eclipse-tractusx#532 from eclipse-tractusx/fix_lin…
Browse files Browse the repository at this point in the history
…ting

fix linting and missing img link issues
  • Loading branch information
Siegfriedk authored Dec 7, 2023
2 parents 89d5d2e + 82bd6bb commit 43600e8
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 15 deletions.
25 changes: 14 additions & 11 deletions docs-kits/kits/Behaviour Twin HI Kit/page_adoption-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ description: 'Health Indicator Kit'
sidebar_position: 2
---

<!--
TODO: Fix missing image
![Health Indicator kit banner](@site/static/img/doc-hi_header-minified.png)
-->

### Health Indicator Kit
<!--
Expand Down Expand Up @@ -70,19 +73,19 @@ The architecture image describes the interaction between the HI Service and the
![Building Block Architecture Overview](images/BT_HI_KIT_Building_Block_Architecture_Overview_V1.png)

### HI Components
|Subsystem|Description|
|---------|-----------|
|HI Application| This component is the app that is hosted at the Consumer/Data Provider. The data provider can select multiple vehicle identifier numbers (VIN) and gets back calculated HI values.|
|Loading Data | A data source at the Data Provider that provides the loading data and other vehicle data that are needed for the HI calculation. <BR> It can be accessed by the knowledge agent via data bindings.|
|HI Service| A HI calculation service at the Service Provider. It accepts input data from the Data Provider, calculates the HI value and returns it.|
|Subsystem| Description |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|HI Application| This component is the app that is hosted at the Consumer/Data Provider. The data provider can select multiple vehicle identifier numbers (VIN) and gets back calculated HI values. |
|Loading Data | A data source at the Data Provider that provides the loading data and other vehicle data that are needed for the HI calculation. <BR/> It can be accessed by the knowledge agent via data bindings. |
|HI Service| A HI calculation service at the Service Provider. It accepts input data from the Data Provider, calculates the HI value and returns it. |

### Knowledge Agent components
|Subsystem|Description|
|---------|-----------|
|Matchmaking Agent|This component supports SparQL to traverse the federated data space as a large data structure. It interacts with the EDC. <UL><LI>The provider's Matchmaking Agent will be activated by its EDC. Therefore, the EDC must offer a Graph Asset (variant of ordinary data assets in the Catena-X EDC standard).</LI><LI> The consumer's Matchmaking Agent interacts with its EDC to negotiate and perform the transfer of Sub-Skills to other dataspace participants.</LI></UL> The Matchmaking Agents are matching the (sub)graphs and negotiate appropriated graph assets with the partner EDCs.|
|Binding Agent| The Binding Agent is a restricted version of the Matchmaking Agent (subset of OWL/SparQL, e.g., without federation) which is just focused on translating Sub-Skills of a particular business domain (Bill-Of-Material, Chemical Materials, Production Sites, etc.) into proper SQL- or REST based backend system calls. <BR> Implementation details: For data bindings, OnTop is used. For service bindings, RDF4J is used.|
|Ontology|The ontology is a formal representation of knowledge that captures concepts, relationships, and properties. It allows a shared understanding and reasoning about the respective domain. <BR> It must be hosted in a way that all participants can access it. Currently, the ontology is hosted at GitHub.|
|Skill/Sub-Skill| The Skill describes, what to do (which data have to be connected, transferred and so on).|
|Subsystem| Description |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|Matchmaking Agent| This component supports SparQL to traverse the federated data space as a large data structure. It interacts with the EDC. <UL><LI>The provider's Matchmaking Agent will be activated by its EDC. Therefore, the EDC must offer a Graph Asset (variant of ordinary data assets in the Catena-X EDC standard).</LI><LI> The consumer's Matchmaking Agent interacts with its EDC to negotiate and perform the transfer of Sub-Skills to other dataspace participants.</LI></UL> The Matchmaking Agents are matching the (sub)graphs and negotiate appropriated graph assets with the partner EDCs. |
|Binding Agent| The Binding Agent is a restricted version of the Matchmaking Agent (subset of OWL/SparQL, e.g., without federation) which is just focused on translating Sub-Skills of a particular business domain (Bill-Of-Material, Chemical Materials, Production Sites, etc.) into proper SQL- or REST based backend system calls. <BR/> Implementation details: For data bindings, OnTop is used. For service bindings, RDF4J is used. |
|Ontology| The ontology is a formal representation of knowledge that captures concepts, relationships, and properties. It allows a shared understanding and reasoning about the respective domain. <BR/> It must be hosted in a way that all participants can access it. Currently, the ontology is hosted at GitHub. |
|Skill/Sub-Skill| The Skill describes, what to do (which data have to be connected, transferred and so on). |

### Catena-X Core Services (except Knowledge Agent components)
|Subsystem|Description|
Expand Down
5 changes: 4 additions & 1 deletion docs-kits/kits/Behaviour Twin HI Kit/page_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ description: 'Health Indicator Kit'
sidebar_position: 1
---

![Health Indicator Kit banner](@site/static/img/doc-hi_header-minified.png) <!-- required HI Kit logo -->
<!--
TODO: Add file/fix build
![Health Indicator Kit banner](FILE_MISSING/static/img/doc-hi_header-minified.png) <!-- required HI Kit logo -->
-->

### Health Indicator Kit

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 2

<!--
TODO: Img reference is broken
![Model Based Development and Data Processing Kit banner](@site/static/img/doc-mdp_header-minified.png)-->
![Model Based Development and Data Processing Kit banner](FILE_MISSING/static/img/doc-mdp_header-minified.png)-->

### Model Based Development and Data Processing Kit
<!--
Expand Down
2 changes: 1 addition & 1 deletion docs-kits/kits/Behaviour Twin MDP Kit/page_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1

<!--
TODO: Img reference is broken
![Model Based Development and Data Processing Kit banner](@site/static/img/doc-mdp_header-minified.png)
![Model Based Development and Data Processing Kit banner](FILE_MISSING/static/img/doc-mdp_header-minified.png)
-->

### Model Based Development and Data Processing Kit
Expand Down
2 changes: 1 addition & 1 deletion src/components/DeveloperContent/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default function DeveloperContent() {
</div>

<p className="description-p">
The first Kit that follows this journey is the <Link to="/docs-kits/kits/Traceability%20Kit/Adoption%20View%20Traceability%20Kit">Traceability Kit.</Link><br></br><br></br>
The first Kit that follows this journey is the <Link to="/docs-kits/kits/Traceability%20Kit/Adoption%20View%20Traceability%20Kit">Traceability Kit.</Link><br/><br/>
Catena-X KITs provide open-source resources and documentation to foster the collaboration and trust governed by the Eclipse Tractus-X Project. The initial offering of the Catena-X ecosystem is structured along the following four domains - one network domain and three business domains:
</p>

Expand Down

0 comments on commit 43600e8

Please sign in to comment.