Skip to content

Commit

Permalink
Lint and refactor mostly all *.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
@florianrusch-zf
florianrusch-zf committed Mar 28, 2023
1 parent 79e8906 commit 84d58ee
Show file tree
Hide file tree
Showing 39 changed files with 465 additions and 519 deletions.
13 changes: 10 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,35 @@ assignees: ''
---

## Describe the bug

_A clear and concise description of what the bug is._

### To Reproduce

_Steps to reproduce the behavior:_

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

_A clear and concise description of what you expected to happen._

### Screenshots/Error Messages

_If applicable, add screenshots and/or error messages to help explain your problem._

## Context Informations

_Add any other context about the probleme here._

- Used version: [e.g. Commit Hash]
- OS: [e.g. Mac OS (M1), Windows, Linux]
- Docker Version: [e.g. 20.10.12]
- `java --version`:
- OS: [e.g. Mac OS (M1), Windows, Linux]
- Docker Version: [e.g. 20.10.12]
- `java --version`:

## Possible Implementation

_You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts._
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ assignees: ''

---

_If you are missing a feature or have an idea how to improve this project that should first be
discussed, please feel free to open up a [discussion](https://github.com/catenax-ng/catena-x-edc/discussions/categories/ideas)._
_If you are missing a feature or have an idea how to improve this project that should first be
discussed, please feel free to open up a [discussion](https://github.com/eclipse-tractusx/tractusx-edc/discussions/categories/ideas)._

**Is your feature request related to a problem? Please describe.**
_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
Expand Down
112 changes: 50 additions & 62 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,58 +130,48 @@ corresponding [documentation](/docs/migration/Version_0.1.x_0.3.x.md).
- Bump actions/setup-java from 3.8.0 to 3.9.0 (#605)
- Bump s3 from 2.18.35 to 2.18.39 (#606)


## [0.2.0] - 2022-12-15
## [0.1.6] - 2023-02-20

### Fixed

- Fixed Json LD serialization bug which prevented multi-BPN policies to be defined and used. Checkout the [docs](https://github.com/catenax-ng/product-edc/blob/0.2.0/edc-extensions/business-partner-validation/README.md) for more info.

## [0.1.3] - 2022-11-30

### Added

- New Postman collection for developers `/docs/development/postman`
- New EDC Image with HashiCorp Vault and InMemory Storage
- (Experimental) Simplified deployment of the EDC in `/charts/tractusx-connector`

### Changed
- SQL leakage issue
- Catalog pagination

- Set EDC version to `0.0.1-20221006-SNAPSHOT`
- Business Partner Number Extension no longer supports the 'IN' constraint operator
- HashiCorp Vault Extension now allows sub directories for secrets
- Update package structure/namespace from `net.catenax` to `org.eclipse.tractusx`
## [0.1.5] - 2023-02-13

### Fixed

- S3 Data Transfer
- Use patched EDC version: 0.0.1-20220922.2-SNAPSHOT to fix catalog pagination bug
- Data Encryption extension: fixed usage of a blocking algorithm

## [0.1.2] - 2022-09-30

### Added

- Introduced DEPENDENCIES file
- Introduced DEPENDENCIES file

### Changed

- Moved helm charts from `deployment/helm` to `charts`
- Moved helm charts from `deployment/helm` to `charts`
- Replaced distroless image with alpine in all docker images
- Update EDC commit to `740c100ac162bc41b1968c232ad81f7d739aefa9`

## [0.1.1] - 2022-09-04

**Important Note**: Please consolidate the migration documentation before updating your connector. [documentation](/docs/migration/Version_0.1.0_0.1.1.md).

### Added

- Control-Plane Extension ([cx-oauth2](/edc-extensions/cx-oauth2/README.md))
- Control-Plane Extension ([cx-oauth2](/edc-extensions/cx-oauth2/README.md))

### Changed

- Introduced git submodule to import EDC dependencies (instead of snapshot- or milestone artifact)
- Helm Charts: TLS secret name is now configurable
- Introduced git submodule to import EDC dependencies (instead of snapshot- or milestone artifact)
- Helm Charts: TLS secret name is now configurable

### Fixed

- Connectors with Azure Vault extension are now starting again [link](https://github.com/eclipse-edc/Connector/issues/1892)
- Connectors with Azure Vault extension are now starting again [link](https://github.com/eclipse-edc/Connector/issues/1892)

## [0.1.0] - 2022-08-19

Expand All @@ -190,93 +180,91 @@ corresponding [documentation](/docs/migration/Version_0.0.x_0.1.x.md).

### Added

- Control-Plane extension ([data-plane-selector-client](https://github.com/eclipse-edc/Connector/tree/v0.0.1-milestone-5/extensions/data-plane-selector/selector-client))
- run the EDC with multiple data planes at once
- Control-Plane extension ([dataplane-selector-configuration](edc-extensions/dataplane-selector-configuration))
- add data plane instances to the control plane by configuration
- Data-Plane extension ([s3-data-plane](https://github.com/eclipse-edc/Connector/tree/main/extensions/aws/data-plane-s3))
- transfer from and to AWS S3 buckets
- Control-Plane extension ([data-encryption](edc-extensions/data-encryption))
- Data-Plane authentication attribute transmitted during data-plane-transfer can be encrypted symmetrically (AES)
- Control-Plane extension ([data-plane-selector-client](https://github.com/eclipse-edc/Connector/tree/v0.0.1-milestone-5/extensions/data-plane-selector/selector-client))
- run the EDC with multiple data planes at once
- Control-Plane extension ([dataplane-selector-configuration](edc-extensions/dataplane-selector-configuration))
- add data plane instances to the control plane by configuration
- Data-Plane extension ([s3-data-plane](https://github.com/eclipse-edc/Connector/tree/main/extensions/aws/data-plane-s3))
- transfer from and to AWS S3 buckets
- Control-Plane extension ([data-encryption](edc-extensions/data-encryption))
- Data-Plane authentication attribute transmitted during data-plane-transfer can be encrypted symmetrically (AES)

### Changed

- Update setting name (`edc.dataplane.token.validation.endpoint` -> `edc.dataplane.token.validation.endpoint`)
- EDC has been updated to version [0.0.1-20220818-SNAPSHOT](https://oss.sonatype.org/#nexus-search;gav~org.eclipse.dataspaceconnector~~0.0.1-20220818-SNAPSHOT~~) - implications to the behavior of the connector have been covered in the [corresponding migration guide](docs/migration/Version_0.0.x_0.1.x.md)
- Update setting name (`edc.dataplane.token.validation.endpoint` -> `edc.dataplane.token.validation.endpoint`)
- EDC has been updated to version [0.0.1-20220818-SNAPSHOT](https://oss.sonatype.org/#nexus-search;gav~org.eclipse.dataspaceconnector~~0.0.1-20220818-SNAPSHOT~~) - implications to the behavior of the connector have been covered in the [corresponding migration guide](docs/migration/Version_0.0.x_0.1.x.md)

### Fixed

- Contract-Offer-Receiving-Connectors must also pass the ContractPolicy of the ContractDefinition before receiving offers([issue](https://github.com/eclipse-edc/Connector/issues/1331))
- Deletion of Asset becomes impossible when Contract Negotiation exists([issue](https://github.com/eclipse-edc/Connector/issues/1403))
- Deletion of Policy becomes impossible when Contract Definition exists([issue](https://github.com/eclipse-edc/Connector/issues/1410))
- Contract-Offer-Receiving-Connectors must also pass the ContractPolicy of the ContractDefinition before receiving offers([issue](https://github.com/eclipse-edc/Connector/issues/1331))
- Deletion of Asset becomes impossible when Contract Negotiation exists([issue](https://github.com/eclipse-edc/Connector/issues/1403))
- Deletion of Policy becomes impossible when Contract Definition exists([issue](https://github.com/eclipse-edc/Connector/issues/1410))

## [0.0.6] - 2022-07-29

### Fixed

- Fixes [release 0.0.5](https://github.com/catenax-ng/product-edc/releases/tag/0.0.5), which introduced classpath issues due to usage of [net.jodah:failsafe:2.4.3](https://search.maven.org/artifact/net.jodah/failsafe/2.4.3/jar) library
- Fixes [release 0.0.5](https://github.com/eclipse-tractusx/tractusx-edc/releases/tag/0.0.5), which introduced classpath issues due to usage of [net.jodah:failsafe:2.4.3](https://search.maven.org/artifact/net.jodah/failsafe/2.4.3/jar) library

## [0.0.5] - 2022-07-28

### Added

- EDC Health Checks for HashiCorp Vault
- EDC Health Checks for HashiCorp Vault

### Changed

- BusinessPartnerNumber constraint supports List structure
- Helm: Confidential EDC settings can be set using k8s secrets
- HashiCorp Vault API path configurable
- BusinessPartnerNumber constraint supports List structure
- Helm: Confidential EDC settings can be set using k8s secrets
- HashiCorp Vault API path configurable

## [0.0.4] - 2022-06-27

### Added

- HashiCorp Vault Extension
- Control Plane with HashiCorp Vault and PostgreSQL support
- HashiCorp Vault Extension
- Control Plane with HashiCorp Vault and PostgreSQL support

### Changed

- Release Worklow now publishes Product EDC Extensions as Maven Artifacts
- Release Workflow now publishes Product EDC Extensions as Maven Artifacts

### Fixed

- [#1515](https://github.com/eclipse-edc/Connector/issues/1515) SQL: Connector sends out 50
- [#1515](https://github.com/eclipse-edc/Connector/issues/1515) SQL: Connector sends out 50
contract offers max.

### Removed

- CosmosDB Control Plane
- Control API Extension for all Control Planes
- CosmosDB Control Plane
- Control API Extension for all Control Planes

## [0.0.3] - 2022-05-23

## [0.0.2] - 2022-05-20

## [0.0.1] - 2022-05-13

[Unreleased]: https://github.com/catenax-ng/product-edc/compare/0.3.0...HEAD

[0.3.0]: https://github.com/catenax-ng/product-edc/compare/0.2.0...0.3.0
[Unreleased]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.1.6...HEAD

[0.2.0]: https://github.com/catenax-ng/product-edc/compare/0.1.3...0.2.0
[0.1.6]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.1.5...0.1.6

[0.1.3]: https://github.com/catenax-ng/product-edc/compare/0.1.2...0.1.3
[0.1.5]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.1.2...0.1.5

[0.1.2]: https://github.com/catenax-ng/product-edc/compare/0.1.1...0.1.2
[0.1.2]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.1.1...0.1.2

[0.1.1]: https://github.com/catenax-ng/product-edc/compare/0.1.0...0.1.1
[0.1.1]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.1.0...0.1.1

[0.1.0]: https://github.com/catenax-ng/product-edc/compare/0.0.6...0.1.0
[0.1.0]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.6...0.1.0

[0.0.6]: https://github.com/catenax-ng/product-edc/compare/0.0.5...0.0.6
[0.0.6]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.5...0.0.6

[0.0.5]: https://github.com/catenax-ng/product-edc/compare/0.0.4...0.0.5
[0.0.5]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.4...0.0.5

[0.0.4]: https://github.com/catenax-ng/product-edc/compare/0.0.3...0.0.4
[0.0.4]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.3...0.0.4

[0.0.3]: https://github.com/catenax-ng/product-edc/compare/0.0.2...0.0.3
[0.0.3]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.2...0.0.3

[0.0.2]: https://github.com/catenax-ng/product-edc/compare/0.0.1...0.0.2
[0.0.2]: https://github.com/eclipse-tractusx/tractusx-edc/compare/0.0.1...0.0.2

[0.0.1]: https://github.com/catenax-ng/product-edc/compare/a02601306fed39a88a3b3b18fae98b80791157b9...0.0.1
[0.0.1]: https://github.com/eclipse-tractusx/tractusx-edc/compare/a02601306fed39a88a3b3b18fae98b80791157b9...0.0.1
22 changes: 11 additions & 11 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ In the interest of fostering an open and welcoming environment, we as community

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Expand All @@ -43,4 +43,4 @@ Project committers or leaders who do not follow the Code of Conduct in good fait

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org) , version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org) , version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,33 @@ where these companies will be able to participate quickly and with little IT
infrastructure investment. Tractus-X is meant to be the PoC project of the
Catena-X alliance focusing on parts traceability.

* https://projects.eclipse.org/projects/automotive.tractusx
* <https://projects.eclipse.org/projects/automotive.tractusx>

## Developer resources

Information regarding source code management, builds, coding standards, and
more.

* https://projects.eclipse.org/projects/automotive.tractusx/developer
* <https://projects.eclipse.org/projects/automotive.tractusx/developer>

The project maintains the source code repositories in the following GitHub organization:

* https://github.com/eclipse-tractusx/
* <https://github.com/eclipse-tractusx/>

## Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation
Development Process and operates under the terms of the Eclipse IP Policy.

* https://eclipse.org/projects/dev_process
* https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf
* <https://eclipse.org/projects/dev_process>
* <https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf>

## Eclipse Contributor Agreement

In order to be able to contribute to Eclipse Foundation projects you must
electronically sign the Eclipse Contributor Agreement (ECA).

* http://www.eclipse.org/legal/ECA.php
* <http://www.eclipse.org/legal/ECA.php>

The ECA provides the Eclipse Foundation with a permanent record that you agree
that each of your contributions will comply with the commitments documented in
Expand All @@ -49,10 +49,10 @@ the email address matching the "Author" field of your contribution's Git commits
fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
<https://www.eclipse.org/projects/handbook/#resources-commit>

## Contact

Contact the project developers via the project's "dev" list.

* https://accounts.eclipse.org/mailing-list/tractusx-dev
* <https://accounts.eclipse.org/mailing-list/tractusx-dev>
14 changes: 6 additions & 8 deletions NOTICE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This content is produced and maintained by the Eclipse Tractus-X project.

* Project home: https://projects.eclipse.org/projects/automotive.tractusx
* Project home: <https://projects.eclipse.org/projects/automotive.tractusx>

See the AUTHORS file(s) distributed with this work for additional information regarding authorship.

Expand All @@ -20,18 +20,16 @@ source code repository logs.

This program and the accompanying materials are made available under the terms
of the Apache License, Version 2.0 which is available at
https://www.apache.org/licenses/LICENSE-2.0
<https://www.apache.org/licenses/LICENSE-2.0>.

SPDX-License-Identifier: Apache-2.0

## Source Code

The project maintains the following source code repositories
in the GitHub organization https://github.com/eclipse-tractusx:

* https://github.com/eclipse-tractusx/<my_product_repo1>
* https://github.com/eclipse-tractusx/<my_product_repo2>
The project maintains the following source code repositories
in the GitHub organization <https://github.com/eclipse-tractusx>:

* <https://github.com/eclipse-tractusx/tractusx-edc>

## Third-party Content

Expand All @@ -46,4 +44,4 @@ may have restrictions on the import, possession, and use, and/or re-export to
another country, of encryption software. BEFORE using any encryption software,
please check the country's laws, regulations and policies concerning the import,
possession, or use, and re-export of encryption software, to see if this is
permitted.
permitted.
Loading

0 comments on commit 84d58ee

Please sign in to comment.