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.

Sign up for GitHub

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

Jump to bottom

docs(trace): traceability kit release for 23.09 (3.2.0) #322

Merged
merged 91 commits into from
Sep 28, 2023
Merged

docs(trace): traceability kit release for 23.09 (3.2.0) #322

merged 91 commits into from
Sep 28, 2023

Conversation

mhellmeier
Copy link
Member

This pull request updates the Traceability KIT to be compatible with the Catena-X release 3.2.0.

markuskeidl and others added 30 commits May 15, 2023 15:18
@markuskeidl
Updated architecture picture to fit to dark mode
5f526e7
@markuskeidl
Merge branch 'eclipse-tractusx:main' into docs/bugfixes-and-updates-f…
71839f5 
…or-r3-1
@markuskeidl
Fixed deprecated references to release 3.0
08c8d1b
@markuskeidl
Initial draft for DTR changes because of EDC asset structure rework
bfeaecc
@markuskeidl
Merge branch 'eclipse-tractusx:main' into docs/edc-asset-structure-re…
af691eb 
…work
@markuskeidl
docs(trace): extended conventions for specifying EDC endpoints in the…
cb29f81 
… DTR
@markuskeidl
chore(trace): Fixed linting errors
dc5dbe6
@mhellmeier
Merge pull request #6 from catenax-ng/docs/edc-asset-structure-rework
2ad96a6 
Update the Traceability KIT because of the EDC asset structure rework for Release 3.2
@markuskeidl
Merge branch 'eclipse-tractusx:main' into docs/trace-release-3.2
2b6b60d
@markuskeidl
docs(trace): updated KIT with changes because of AAS v3.0
962cff5
@markuskeidl
docs(trace): fix conflicts for pull request #8
79e2f41
@markuskeidl
Merge branch 'eclipse-tractusx:main' into docs/trace-release-3.2
4359fb3
@mhellmeier
Merge pull request #8 from catenax-ng/docs/trace-update-to-aas30-v2
6c3dd39 
docs(trace): updated KIT with changes because of AAS v3.0
@markuskeidl
docs(trace): Updated conventions for submodel descriptors and EDC ass…
b6d382c 
…et structure to give data provides more flexibility in how to create EDC assets for submodels of digital twins
@markuskeidl
fix(trace): removed wrong postfix from submodel descriptor example
1fff8a0
@markuskeidl
docs(trace): improved description which profile the endpoint must sup…
9bb4477 
…port and how to invoke it
@markuskeidl
docs(trace): updated subprotocolBody content based on changes for EDC…
2b0576c 
… 0.4.x

With EDC 0.4.x, the asset:prop:* fields no longer exists and are replaced with a DCAT Catalog based approach. Filter criteria as previously defined no longer work. As a quick fix, only the asset id (referenced by id) is allowed in subprotocolBody for release 3.2.
@markuskeidl
fix(trace): fixed missing "," in JSON examples
55c4fea
@markuskeidl
Merge branch 'docs/trace-release-3.2' into docs/trace-edc-asset-struc…
418766e 
…ture-rework
@markuskeidl
docs(trace): updated KIT to reflect that a decentralized DTR is used
9244a81
@mhellmeier
Merge pull request #10 from catenax-ng/docs/trace-decentralized-regis…
2eea0b2 
…try-v2

docs(trace): updated KIT to reflect that a decentralized DTR is used
@markuskeidl
fix(Trace): fixed issues with wrong whitespaces
5c75e47
@markuskeidl
fix(Trace): added missing changelog messages for previous pull requests
d281290
@markuskeidl
Merge branch 'docs/trace-release-3.2' into docs/trace-edc-asset-struc…
b9e8ae9 
…ture-rework
@jacewski-bosch
updated SerialPartTyzation 1.1.1 to SerialPart1.0.0 in development vi…
84dac5e 
…ew, adoption view
@jacewski-bosch
updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0…
3e03e33 
… in Traceability Kit
@jacewski-bosch
added sample data for traction battery code
9f9c066
@mhellmeier
Merge pull request #9 from catenax-ng/docs/trace-edc-asset-structure-…
dd0437d 
…rework

docs(trace): updated conventions for submodel descriptors and EDC asset structure
@jacewski-bosch
made sample data more realistic (changed Traction Battery Codes)
0f3f82d
@markuskeidl
docs(trace): described usage if interface and href more clearly
6f99732
@SebastianBezold
Copy link
Contributor

From my point of view just a view minor things, that would not block a merge, but could be considered for further improvement:

  • Clarify references to "Catena-X release". In my point of view, there is no Catena-X release and "Tractus-X release" is meant
  • Add a few more reference links. I.e. Standards in it's version on catena-x.net (changelog + in text)

SebastianBezold
SebastianBezold approved these changes Aug 18, 2023
View reviewed changes
Copy link
Contributor

@SebastianBezold SebastianBezold left a comment

Choose a reason for hiding this comment

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

LGTM overall, but cannot provide feedback on the contents, so further approvals should be given

@mhellmeier
Copy link
Member Author

Based on @SebastianBezold comments:

  • Clarify references to "Catena-X release". In my point of view, there is no Catena-X release and "Tractus-X release" is meant

I updated the files accordingly to only mention "release" instead of "Catena-X release" to reduce misunderstandings.

  • Add a few more reference links. I.e. Standards in it's version on catena-x.net (changelog + in text)

I updated and added some links to the standards. Nevertheless due to the current timeline, it isn't possible to link to the correct standard. As I understand, @danielmiehle will discuss this in the lifecycle process.

@mhellmeier
Copy link
Member Author

This pull request is still in Draft mode since it waits for internal approval of the traceability use case team as well as a successful quality gate check.

If both things are fulfilled, I will change it to be ready for the merge.

maximilianong
maximilianong reviewed Aug 21, 2023
View reviewed changes
Copy link
Contributor

@maximilianong maximilianong left a comment

Choose a reason for hiding this comment

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

Can you please add the versions of the standards you are referencing to
(e.g. CX - 0004 Semantic Model V 1.0.1)

@maximilianong maximilianong marked this pull request as ready for review August 21, 2023 13:29
maximilianong
maximilianong approved these changes Aug 21, 2023
View reviewed changes
Copy link
Contributor

@maximilianong maximilianong left a comment

Choose a reason for hiding this comment

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

After IP clearance - PR will be merged.

@mhellmeier mhellmeier changed the title docs(trace): traceability kit release for 3.2.0 docs(trace): traceability kit release for 23.09 (3.2.0) Sep 28, 2023
mhellmeier and others added 10 commits September 28, 2023 10:32
@mhellmeier
Merge branch 'main' into docs/trace-release-3.2
34aa9b9
@mhellmeier
docs(trace): distinguish between 3.1.0 and next version
99e091d
@mhellmeier
docs(trace): clarify standard links and release
5a0ade8
@markuskeidl @mhellmeier
docs(trace): Removed optional customer attributes from Batch example
0b97028
@mhellmeier
docs(trace): fix versioning, links and naming
76de881
@markuskeidl @mhellmeier
docs(trace): updated version for aspect model Batch from 1.0.2 to 2.0.0
328c630
@markuskeidl @mhellmeier
docs(trace): updated how to define visibility for digital twins based…
a1db440 
… on the concept
@mhellmeier
Merge pull request #21 from catenax-ng/docs/trace-batch-example-fix
d9a502a 
docs(trace): Removed optional customer attributes from Batch aspect model
@mhellmeier
Merge pull request #22 from catenax-ng/docs/trace-dtr-permissions-v3
99457d4 
docs(trace): updated how to define visibility for digital twins based on the concept
@mhellmeier
docs(trace): create release 23.09
48281ed
@mhellmeier mhellmeier force-pushed the docs/trace-release-3.2 branch from 10c7a90 to 48281ed Compare September 28, 2023 08:32
@mhellmeier
Copy link
Member Author

After IP clearance - PR will be merged.

Just to let you know, IP clearance has been successful. The branch is updated to the current status of main accordingly. All kit changes are integrated into the new versioned structure. Ready to be merged, @maximilianong!

@maximilianong maximilianong merged commit ec8d9e2 into eclipse-tractusx:main Sep 28, 2023
@mhellmeier mhellmeier deleted the docs/trace-release-3.2 branch October 19, 2023 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maximilianong maximilianong maximilianong approved these changes

@SebastianBezold SebastianBezold SebastianBezold approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mhellmeier @SebastianBezold @maximilianong @danielmiehle @markuskeidl @jacewski-bosch @klanir123