Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: updated reference links to the Supporting Infrastructure Deployment #400

Closed
wants to merge 1 commit into from

Conversation

MarkAshraf96
Copy link

The reference links to the TXDC Supporting Infrastructure were outdated and routes to files that no longer exits.

Closes #399

The reference links to the TXDC Supporting Infrastructure were outdated and routes to files that no longer exits.
@sonarcloud
Copy link

sonarcloud bot commented May 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@paullatzelsperger
Copy link
Contributor

paullatzelsperger commented May 23, 2023

First of all, thanks for you contribution! The document you worked on refers to the "business test" environment, which doesn't exist anymore, so the Local TXDC Setup document should be deleted.
However, if you like, instead of deleting the document, you could document and explain how the deployment tests (cf .github/workflows/deployment-test.yaml) work, and how to run them locally?

Please also be aware of PR #354

@MarkAshraf96
Copy link
Author

So which document should I follow if I wanna setup the Tractus-x EDC on my machine and run a basic scenario?
I would also like to know how the documentation of the test could be a replacement for the documentation of the setup, as I would like to do that contribution.

@paullatzelsperger
Copy link
Contributor

paullatzelsperger commented May 23, 2023

So which document should I follow if I wanna setup the Tractus-x EDC on my machine and run a basic scenario?

That's the point - there isn't one at the moment. And to be clear, the "Local TXDC..." document doesn't show you that either, it only shows you how to run a bunch of tests, which have been replaced by more appropriate and efficient tests.

I think there are two general issues here:

  1. showing (and documenting) how one TX-EDC connector can be operated, what the required configuration is, etc. For that, I would suggest looking at the deployment-test.yaml file, because all that's needed is already there.
  2. showing (and documenting) a scenario, where two connectors run in a dataspace, what the configuration for each one is, how they communicate, what requests can be executed against either one, etc. That would effectively be a "demo dataspace" and it is certainly the more labor-intense of the two, by a wide margin. For that, you could look at AbstractCatalogTest.java and AbstractHttpConsumerPullWithProxyTest.java

I would also like to know how the documentation of the test could be a replacement for the documentation of the setup, as I would like to do that contribution.

That is admirable, i would suggest you start with issue 1. document how people can run one connector. When you do that, also take note of PR #370 which converts all helm charts to be self-contained. Once that is accepted into the code base, you could venture on to implement/document point 2. the "mini dataspace".

@stephanbcbauer
Copy link
Member

#314 should be the step by step guide? @MarkAshraf96

@paullatzelsperger
Copy link
Contributor

paullatzelsperger commented Jun 21, 2023

@MarkAshraf96 @stephanbcbauer I will close this PR, because the "supporting infrastructure" does not exist anymore (e.g. DAPS is scheduled to be removed in 0.5.0) and we now have an "example dataspace" in docs/samples that shows how to run two connectors.

If you disagree, I'd be keen to hear your reasoning, but we could re-open this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Reference links to the Supporting Infrastructure files are outdated.
3 participants