Skip to content

Commit

Permalink
Merge pull request #702 from bcronin90/fix/connector-linting-issues
Browse files Browse the repository at this point in the history
fix: Markdownlint
  • Loading branch information
stephanbcbauer authored Mar 5, 2024
2 parents 127c616 + a13d17c commit c9f8647
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
10 changes: 5 additions & 5 deletions docs-kits/kits/Connector Kit/Adoption View/adoption-view.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: Adoption View
title: Adoption View
description: 'Connector Kit'
sidebar_position: 1
title: Adoption View
description: Adoption View
id: connector_kit_adoption_view
---

# Adoption View
Expand Down Expand Up @@ -41,7 +41,7 @@ With the [EDC][edc-url], a new communication component was introduced, which imp

## Use Case

The EDC is the enabling component for all use cases within Catena-X and the only component to execute the exchange of operational data to Data Space participants. The base use case is therefore the exchange of data between to partners. Value creation along the automotive value chain is tied to processing data in specific contexts. Within Catena-X exist 10 use cases companies can participate in. Active participation in given use cases always requires the use of a connector compliant to the [DSP](dsp-url) such as the [EDC][edc-url]. Depending on the use case a participant chooses to participate in, further components will be required explained in subsequent Kits.
The EDC is the enabling component for all use cases within Catena-X and the only component to execute the exchange of operational data to Data Space participants. The base use case is therefore the exchange of data between to partners. Value creation along the automotive value chain is tied to processing data in specific contexts. Within Catena-X exist 10 use cases companies can participate in. Active participation in given use cases always requires the use of a connector compliant to the [DSP][dsp-url] such as the [EDC][edc-url]. Depending on the use case a participant chooses to participate in, further components will be required explained in subsequent Kits.

- [Sustainability][sustainability-url]
- [Traceability][traceability-url]
Expand Down Expand Up @@ -83,7 +83,7 @@ The Connector KIT builds on the [Catena-X Standards][Catena-X-Standards-url]. Ev

### Terminology

The shown picture illustrates only a generic view of the EDC's Domain Model and is not intended to show all aspects of
The shown picture illustrates only a generic view of the EDC's Domain Model and is not intended to show all aspects of
the implementation. Most of the Domain-Model-Elements are represented by separate APIs. Please check the [Management API Walkthrough](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs)
in the tractusx-edc repository for more a reference on usage of the API.

Expand Down
12 changes: 6 additions & 6 deletions docs-kits/kits/Connector Kit/Development View/architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Architecture
sidebar_position: 2
title: Architecture
description: Architecture
id: connector_kit_development_view_architecture
---
<!--
* Copyright (c) 2022,2023 Contributors to the Eclipse Foundation
Expand All @@ -21,8 +23,6 @@ sidebar_position: 2
* SPDX-License-Identifier: Apache-2.0
-->

# Architecture

## Overview

The following diagram shows an example architecture including the Connector Kit. In this case the EDC is used as a sample implementation of the Connector Kit.
Expand All @@ -43,15 +43,15 @@ In the reference implementation, this metadata is generated by the management pl

A Connector is a security-critical component. It handles credentials, secrets and short-lived that must be shielded from
unauthorized access and potential leaks. A ordinary database is unfit for this task, thus the setup requires a Secret Vault.
This is usually accomplished via a implementations such as Hashicorp Vault or Azure Vault.
This is usually accomplished via a implementations such as Hashicorp Vault or Azure Vault.

### Business Applications

The reason to use a Connector in the first place is to make data available to or obtain it from other participants.
This data comes from or is used in your other Business Applications.
These interact with the Connector by providing addresses where said data can be found that are then wrapped in Assets by the Connector.
For the reference implementation, the interaction will usually pass through the Management API that is [documented in
detail](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs) in the tractusx-edc repository.
For the reference implementation, the interaction will usually pass through the Management API that is [documented in detail](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/docs)
in the tractusx-edc repository.

### Other Connectors

Expand Down
10 changes: 5 additions & 5 deletions docs-kits/kits/Connector Kit/Development View/specifications.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Specifications
sidebar_position: 1
title: Specifications
description: Specifications
id: connector_kit_development_view_specifications
---

# Specifications

The following describes the standards for implementation of the Connector Kit.
They detail the necessary functionality of as well as the expected communication with a Connector.

Expand All @@ -20,8 +20,8 @@ In the reference implementation, these are the management plane and the data pla

## Identity and Trust Protocol (IATP)

In Catena-X, the interaction between the wallets holding a participant's identity credentials and the connector is
specified by the [IATP](https://github.com/eclipse-tractusx/identity-trust). This protocol is currently under development with the Eclipse-Tractusx community and will find
In Catena-X, the interaction between the wallets holding a participant's identity credentials and the connector is
specified by the [IATP](https://github.com/eclipse-tractusx/identity-trust). This protocol is currently under development with the Eclipse-Tractusx community and will find
its way into the IDSA and international standardization bodies.

## Catena X Standard Library
Expand Down
10 changes: 5 additions & 5 deletions docs-kits/kits/Connector Kit/Operation View/operation-view.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Operation View
sidebar_position: 1
title: Operatation View
description: Operatation View
id: connector_kit_operation_view
---

# Operation View

## Reference Implementation

The reference implementation for the Connector kit is the [Eclipse Dataspace Connector](https://github.com/eclipse-edc/Connector).
Expand All @@ -30,14 +30,14 @@ Other configurations are available in the same repository.

### Minimum Viable Dataspace

A minimal setup using [Terraform](https://developer.hashicorp.com/terraform) is available in the form of the
A minimal setup using [Terraform](https://developer.hashicorp.com/terraform) is available in the form of the
[Minimum Viable Dataspace](https://github.com/eclipse-edc/MinimumViableDataspace).

Documentation on it can be found [here](https://eclipse-edc.github.io/docs/#/submodule/MinimumViableDataspace/).

### Deployment Guide

Specific configuration details are described more closely in the
Specific configuration details are described more closely in the
[Deployment Guide](https://eclipse-tractusx.github.io/docs/tutorials/e2e/connect/deployComponents/).

## Notice
Expand Down
6 changes: 3 additions & 3 deletions sidebarsDocsKits.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,13 @@ const sidebars = {
},
collapsed: true,
items: [
'kits/Connector Kit/Adoption View/Adoption View',
'kits/Connector Kit/Adoption View/connector_kit_adoption_view',
{
type: 'category',
label: 'Development View',
link: {
type: 'doc',
id: 'kits/Connector Kit/Development View/specifications'
id: 'kits/Connector Kit/Development View/connector_kit_development_view_specifications'
},
items: [
{
Expand All @@ -217,7 +217,7 @@ const sidebars = {
},
]
},
'kits/Connector Kit/Operation View/operation-view',
'kits/Connector Kit/Operation View/connector_kit_operation_view',

],
},
Expand Down

0 comments on commit c9f8647

Please sign in to comment.