updated the readme which was the original tractus-x readme before#8
Open
rgalan-dev wants to merge 1 commit into
Open
updated the readme which was the original tractus-x readme before#8rgalan-dev wants to merge 1 commit into
rgalan-dev wants to merge 1 commit into
Conversation
mhellmeier
requested changes
May 28, 2026
|
|
||
| [![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. |
Member
There was a problem hiding this comment.
Suggested change
| 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 |
Member
There was a problem hiding this comment.
Suggested change
| - Helm charts and container images | |
| - Helm charts and docker compose setup |
We are currently not providing images.
Comment on lines
+27
to
38
| ### 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/) |
Member
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
Comment on lines
64
to
+76
| ## 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 | ||
| ``` |
Member
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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