Skip to content

Commit

Permalink
chore: adds a Notice section to all Markdown files in doc/
Browse files Browse the repository at this point in the history
  • Loading branch information
paullatzelsperger committed Dec 7, 2023
1 parent 110625a commit a52b2a2
Show file tree
Hide file tree
Showing 50 changed files with 376 additions and 74 deletions.
8 changes: 8 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,11 @@ The three supported setups are.
- [EDC Domain Model](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/architecture/domain-model.md)
- [EDC Open API Spec](https://github.com/eclipse-edc/Connector/blob/main/resources/openapi/openapi.yaml)
- [HTTP Receiver Extension](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/http-receiver)

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/development/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,11 @@ The Eclipse Bot is able to approve dependencies automatically, if the license ca

[maven-shield]: https://img.shields.io/badge/Apache%20Maven-URL-blue
[maven-url]: https://maven.apache.org

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/development/coding-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,11 @@ and register with the `HealthCheckService`, thus reporting the service's readine

1. Always close explicitly `Stream` objects that are returned by a service/store, since they could carry a connection,
which otherwise would leak.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,11 @@ current date, we can start the nightly. If the EDC nightly doesn't appear within
which prescribes the use of Jenkins for publishing to MavenCentral and OSSRH.
- Typically, GitHub Actions should perform all verification tasks, running tests, etc. and Jenkins' only purpose is to
publish.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,11 @@ This section explains _at which point in time_ we should execute which test. Thi
| System/End-To-End test | on pull request branches except when marked as `draft` | |
| Deployment test | before merging pull requests and on every commit on `main` | |
| Performance test | Only on a specific schedule, e.g. once per day or week | |

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,11 @@ parallelization resulting in faster and more responsive builds.
Planned improvements regarding the testing procedure will also greatly benefit from the EDC build tools such
as JUnit tags and conditional evaluation of the tagged tests. Much of EDC's testing framework is based on Gradle and can
be seamlessly integrated in tractusx-edc.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,11 @@ should not build those obstructions into the code base.
## Further consideration

We can even expect a slightly faster build, because "delomboking" will become unnecessary.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,11 @@ like force-pushing. Write access to `upstream` is required!_
The new `releases` branch (note the plural) will serve the same purpose that `main` did up until now, which is to track
all releases (via merge commits and tags) in chronological order. We will continue to have separate `release/x.y.z`
branches for every release.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,11 @@ edc-dataplane
|-> edc-dataplane-hashicorp-vault
|-> edc-dataplane-azure-vaul
```

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@ to (auto-generated) documentation, render visually appealing version information
number of tooling on top of cc's.
One key aspect would be to get rid of the manual changelog,
see [this discussion](https://github.com/eclipse-tractusx/tractusx-edc/discussions/253).
## NOTICE
This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@ Our CI pipeline already uses checkstyle, but only outputs warning at the moment.

- in `resources/tx-checkstyle-config.xml`, Line 22, change `<property name="severity" value="warning"/>` to `<property name="severity" value="error"/>`.
- fix all checkstyle errors

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,11 @@ version to the current LTS from time to time.
## Approach

Remove the custom `javaVersion` and let the `edc-build` plugin set that when upgrading to the newest version of EDC.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@ support for `JsonWebKey2020` which was mandated by the Catena-X consortium.
## Approach

- add support for `JsonWebKey2020` to Tractus-X EDC using `iron-verifiable-credentials`.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,11 @@ This is also reflected in the automatically generated changelog, for
example [0.5.0-rc5](https://github.com/eclipse-tractusx/tractusx-edc/releases/tag/0.5.0-rc5). Once that is fixed, we can
delete the CHANGELOG.md file
and [this GH action to update it (line 44)](../../../../.github/workflows/draft-new-release.yaml).

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,11 @@ in the example), or using a vocabulary entry in the JSON-LD context, i.e. `tx:Bu
will be: `eq, neq, in, isAllOf, isAnyOf, isNoneOf`.

Manipulating the BPN -> group associations can be done through a REST API.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,11 @@ An application process for possible additional integrations will follow at a lat
What is the process for including/supporting additional Cloud Vendors?

Who will maintain the vendor specific solutions in the long-term (after the consortia phase)?

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,11 @@ receive the `triage` label upon creation.
- bug reports are ignored by the stale bot
- issues in the `backlog` are ignored by the stale bot
- pull-requests get staled after 1 week, and closed after 1 more week

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/development/postman/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,11 @@ The postman collection contains the most common API calls. Please note that the

[postman-shield]: https://img.shields.io/badge/Postman-URL-orange
[postman-url]: https://www.postman.com

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
27 changes: 0 additions & 27 deletions docs/development/scripts/daps_token/README.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/development/scripts/daps_token/daps_auth.sh

This file was deleted.

2 changes: 0 additions & 2 deletions docs/development/scripts/daps_token/key.pem

This file was deleted.

8 changes: 8 additions & 0 deletions docs/kit/Adoption View/00_adoption-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@ The architecture of the EDC combines various services that are necessary for the
[gaiax-url]: https://www.data-infrastructure.eu/GAIAX/Navigation/EN/Home/home.html
[idsa-url]: https://internationaldataspaces.org/
[daps-url]: https://www.dataspaces.fraunhofer.de/en/software/identity_provider.html

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Development View/01_domain_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,11 @@ as well as information about the [data destination](#data-address).

Similar to the `ContractNegotiation`, this object captures the current state of a data transfer. This process is
inherently asynchronous, so the `TransferProcess` objects are stored in a backing data store (`TransferProcessStore`).

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Development View/02_OpenAPI/00_open_api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# OpenAPI

The following is an automatically generated OpenAPI spec for the TractusX EDC.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Development View/05_EDC Extensions/00_extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,11 @@ This extension adds that functionality.
## Transfer Process SFTP

This extension allows for the use of SFTP backends for the data plane (but is not included in the provided control- and data plane).

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Documentation/00_repository_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,11 @@ and [control plane](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/e
To facilitate deployment of these different builds and their prerequisites,
Helm charts are provided. The charts and their documentation can be found
[here](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/charts/README.md).

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Documentation/01_project_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@ Other branches should follow the naming conventions of `feature/x` or `hotfix/x`
We use Java 17 with Gradle for dependencies and builds.
We use [Checkstyle](https://github.com/checkstyle/checkstyle) for code formatting.
Releases are in the form of Docker containers and Helm charts.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Operation View/00_operation_view.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,11 @@ The data plane does the heavy lifting of transferring and receiving data streams

Each of these planes comes in several variants, allowing for example secrets to be stored in Azure Vault or a Hashicorp Vault.
The setup on the following pages assumes the use of Hashicorp Vault for secrets and PostgreSQL for data storage.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
8 changes: 8 additions & 0 deletions docs/kit/Operation View/01_technical_prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@ Helm charts are provided to set up these services locally.
## All-in-one deployment

An all-in-one deployment is no longer in scope and will not be provided.

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2021,2022,2023 Contributors to the Eclipse Foundation
- Source URL: <https://github.com/eclipse-tractusx/tractusx-edc>
Loading

0 comments on commit a52b2a2

Please sign in to comment.