doc(tutorials): adapt tutorial description to fit new structure/basis #885
Conversation
adapt the new curl commands match them to the new umbrella infrastructure
Updated list of required installations
configuration and installation information updated for the new approach using helm charts for the deployment
doc(tutorials): update e2e tutorials to work with umbrella helm charts and minikube
doc(tutorials): update prerequisites on use of minikube and helm charts
- updated architecture section
stephanbcbauer
added
the
documentation
|
@jkbquabeck @drandarov-io not sure who created the Step1.png pictures… but we definitely have to store also the sources here. Since it looks like mermaid, maybe we can add the mermaid code directly into the md files. And since the tutorial is not versioned via docusaurus, we could also think about storing our assets in the static folder of docusaurus. |
|
@drandarov-io can you please check the linter issues? And I am not sure if the header hierarchy is correct? |
Chapter "deploy" was not reworked, therefore I added some special notes.
|
Please fix dependencies file by either rebasing on main or using the dash licences tool [1], follow these instructions [2] or try executing this [3] command. [1] https://repo.eclipse.org/content/repositories/dash-licenses/org/eclipse/dash/org.eclipse.dash.licenses/ |
Fixed typos and rewrote certain parts of the section for clearer explaination. Implemented a new logic for using info-section: Info-sections provide information which account to the architecture of the tutorial setup. The general text provides information on the overall architecture of Catena-X
fixed typos
Reworked ot the chapter also introducing aspects for a user setup, which also to run the tutorial without root privileges
minor corrections - spelling
Rework for the usage of Umbrella Helm Charts instead of terraform and usenig minikube instead of kind
Changeing MXD to TXD
Rework for using Umbrella Helm Charts and minikube
Thanks @arnoweiss adapted the description. Please have a look. I am still waiting for the eclipse itself because of the big number of changes. |
| "edc":"https://w3id.org/edc/v0.0.1/ns/", | ||
| "cx-common":"https://w3id.org/catenax/ontology/common#", | ||
| "cx-taxo":"https://w3id.org/catenax/taxonomy#", | ||
| "dct":"https://purl.org/dc/terms/" |
There was a problem hiding this comment.
| "dct":"https://purl.org/dc/terms/" | |
| "dct":"http://purl.org/dc/terms/" |
This will come up multiple times, there used to be an error in a spec somewhere that spread. For reference, check https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#type
There was a problem hiding this comment.
@tunacicek and I adapted the URLs together
| "dcat:accessService": "7b76c9c5-d7f9-42c1-8784-a2820a60bb0f" | ||
| } | ||
| ], | ||
| "edc:type": "data.core.digitalTwinRegistry", |
There was a problem hiding this comment.
again: it shouldn't look like this
There was a problem hiding this comment.
This asset was created by the seeedData function from the umbrella chart. What do you mean? This asset was created like this.
There was a problem hiding this comment.
might make sense to include the specific queryspec somewhere. it's not in the text either.
{
"@context": {
"edc": "https://w3id.org/edc/v0.0.1/ns/"
},
"@type": "CatalogRequest",
"counterPartyAddress": "{{provider_dsp_url}}",
"counterPartyId": "{{provider_bpn}}",
"protocol": "dataspace-protocol-http",
"querySpec": {
"offset": 0,
"limit": 200,
"filterExpression": {
"operandLeft": "'http://purl.org/dc/terms/type'.'@id'",
"operator": "=",
"operandRight": "https://w3id.org/catenax/taxonomy#DigitalTwinRegistry"
}
}
}There was a problem hiding this comment.
The tutorial was meant really as a basic description. It shouldn't be too complicated, that's why we didn't add any extra functionality.
There was a problem hiding this comment.
might make sense to clarify what happens when you have to and-chain specificAssetIds as that's the usual case in industry-core-based scenarios
There was a problem hiding this comment.
Sorry, don't know you mean with this statement
There was a problem hiding this comment.
same here. explain filter?
|
@arnoweiss thx will have a look. @tunacicek maybe we can collaborate here? |
Co-authored-by: Arno Weiß <86715435+arnoweiss@users.noreply.github.com>
Co-authored-by: Arno Weiß <86715435+arnoweiss@users.noreply.github.com>
Co-authored-by: Arno Weiß <86715435+arnoweiss@users.noreply.github.com>
Co-authored-by: Arno Weiß <86715435+arnoweiss@users.noreply.github.com>
Co-authored-by: Arno Weiß <86715435+arnoweiss@users.noreply.github.com>
It would be great, the problem … we are working on @jkbquabeck fork/branch. Will try to contact him. |
This reverts commit bdf3f37.
Description
Since the basis of the tutorial was switched from tutorial-resources to tractus-x-umbrella also the description has to be adpated.
Since the changes on this PR are really huge ... here is a small description
Important We didnt change any functionality. The changes were done within an external team in the tractus-x-umbrella. We are just using the new provided infrastructure.
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: