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

added section MXD tutorial 1 data exchange #97

Closed

Conversation

jkbquabeck
Copy link
Contributor

Description

This PR publishes the first MXD tutorial on initiating data exchange within the MXD. This adds one tutorial document and one image. This was requested in issue #315 (eclipse-tractusx/eclipse-tractusx.github.io#315). The MXD tutorials are to be published in different repositories, starting with tutorial_resources.

Pre-review checks

@jkbquabeck jkbquabeck requested a review from FaGru3n October 9, 2023 15:17
@jkbquabeck jkbquabeck marked this pull request as ready for review October 9, 2023 15:17
Copy link
Contributor

@paullatzelsperger paullatzelsperger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

careful with diagrams: please use the exact terms as they appear in the EDC, i.e. Asset rather than Data Asset.
Please do not just check in PNGs, because they cannot be altered, they should be generated with PlantUML and the source code should be checked in. You should not check in formats, that can only be opened with proprietary tools like Visio!

@@ -0,0 +1,181 @@
# Provide and consume data

As described in the introduction, a data exchange between Bob (Data Provider) and Alice (Data Consumer) is to be tested.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As described in the introduction, a data exchange between Bob (Data Provider) and Alice (Data Consumer) is to be tested.
As described in the introduction, Bob (Provider) wants to exchange data with Alice (Consumer).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why dont we call the participants Data Provider and Data Consumer? These are the terms stated in the new regulatory framework.

mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
Copy link

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jkbquabeck thanks for your contribution.

For content within the tutorial i guess i´m not the perfect one to validate.

But also want to state out to store diagramms in a format like @paullatzelsperger already mentioned.

FYI referenced PR eclipse-tractusx/eclipse-tractusx.github.io#401

and some help for creating either mermaid or puml files.

Technical requirements

@jkbquabeck
Copy link
Contributor Author

@hemantxpatel I updated the contents according to Paul's change requests. Would you take a look at the contract policy he is referring to and provide a fitting one, distinct from policy with ID:3?

mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
mxd/3.1_MXD_tutorial1_dataexchange.md Outdated Show resolved Hide resolved
@jkbquabeck
Copy link
Contributor Author

@hemantxpatel Changed curl commands as requested. @paullatzelsperger there is one comment still open.
@stephanbcbauer once this PR is approved you can use the updated contents in the github.io repo feat/tutorials branch.
If approval is granted, do not merge this PR but close it, to avoid redundancy.

@stephanbcbauer
Copy link
Member

@hemantxpatel Changed curl commands as requested. @paullatzelsperger there is one comment still open. @stephanbcbauer once this PR is approved you can use the updated contents in the github.io repo feat/tutorials branch. If approval is granted, do not merge this PR but close it, to avoid redundancy.

@jkbquabeck ok thx. But until now its not approved :)

@hemantxpatel
Copy link
Contributor

@jkbquabeck Could you please incorporate review comments. Can we get this PR merged since it's pending since long.

@jkbquabeck
Copy link
Contributor Author

@hemantxpatel @paullatzelsperger This PR can be closed and the other connected documents removed, as suggested in #136.
The new contents with the changes requested in this PR can be found here: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/feat/tutorials/docs/tutorials/e2e/boost/provideData.md

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

Successfully merging this pull request may close these issues.

5 participants