updated the readme which was the original tractus-x readme before#8
updated the readme which was the original tractus-x readme before#8rgalan-dev wants to merge 1 commit into
Conversation
|
|
||
| [![Latest Release][release-shield]][release-url] | ||
| [![Latest Snapshot][snapshot-shield]]() | ||
| Construct-X specific Eclipse Dataspace Connector distributions and extensions, based on the Eclipse Tractus-X EDC. |
There was a problem hiding this comment.
| Construct-X specific Eclipse Dataspace Connector distributions and extensions, based on the Eclipse Tractus-X EDC. | |
| [Construct-X](https://www.construct-x.org/) specific Eclipse Dataspace Connector distributions and extensions, based on the [Eclipse Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc). |
Add some links.
| This repository provides: | ||
| - Construct-X specific EDC extensions | ||
| - Control-Plane and Data-Plane distributions | ||
| - Helm charts and container images |
There was a problem hiding this comment.
| - Helm charts and container images | |
| - Helm charts and docker compose setup |
We are currently not providing images.
| ### Control Plane distributions | ||
|
|
||
| - [edc-controlplane-postgresql-hashicorp-vault](edc-controlplane/edc-controlplane-postgresql-hashicorp-vault) with | ||
| dependency onto | ||
| dependencies on | ||
| - [Hashicorp Vault](https://www.vaultproject.io/) | ||
| - [PostgreSQL 8.2 or newer](https://www.postgresql.org/) | ||
| - [edc-runtime-memory](edc-controlplane/edc-runtime-memory) | ||
|
|
||
| Data-Plane distribution: | ||
| ### Data Plane distributions | ||
|
|
||
| - [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-hashicorp-vault) with dependency onto | ||
| - [edc-dataplane-hashicorp-vault](edc-dataplane/edc-dataplane-hashicorp-vault) with dependencies on | ||
| - [Hashicorp Vault](https://www.vaultproject.io/) |
There was a problem hiding this comment.
The links are wrong. Please update them to the correct construct-x control and dataplane.
Example for the controlplane is edc-controlplane/edc-controlplane-construct-x :
https://github.com/project-construct-x/constructx-edc/tree/develop/edc-controlplane/edc-controlplane-construct-x
| ## Getting Started | ||
|
|
||
| ### Build | ||
|
|
||
| Build Tractus-X EDC together with its Container Images | ||
| Build Construct-X EDC together with its Container Images | ||
|
|
||
| ```shell | ||
| ./gradlew dockerize | ||
| ``` | ||
|
|
||
| ## Known Incompatibilities | ||
|
|
||
| - Hashicorp Vault 1.18.1 is not compatible with the EDC due to a bug in the vault concerning path handling | ||
| - [Internal Issue](https://github.com/eclipse-tractusx/tractusx-edc/issues/1772) | ||
| - [Hashicorp Vault Issue](https://github.com/hashicorp/vault/issues/29357) | ||
|
|
||
| ```shell | ||
| ./gradlew build | ||
| ``` |
There was a problem hiding this comment.
The Getting Started guide should not mention the dockerize and build command. Instead, it should link to the local setup.
I suggest combining the "Local Testbed" section from above with this Getting Started section. If people want to get into the topic, they should start with the local testbed.
WHAT
Updated the top-level README to better reflect the Construct-X EDC project instead of the upstream Tractus-X README.
The README now:
WHY
The previous README was still largely identical to the upstream Tractus-X repository and did not clearly communicate the Construct-X specific context, structure and development resources.
This change improves onboarding and repository navigation for developers working on Construct-X EDC.
FURTHER NOTES
Closes #CXAP4-244