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

chore: updated dpp-verification docs with more detailed explanations #369

Merged
merged 26 commits into from
Jul 19, 2024

Conversation

matbmoser
Copy link
Contributor

@matbmoser matbmoser commented Jul 8, 2024

Why we create this PR?

The documentation published with V1 of the last release R24.05 needs to be updated to match the latest PoC of the digital product passport application.

What we want to achieve with this PR?

Have the documentation updated and without any typos. Giving examples and explaining clearly how the concept works.

What is new?

Added

  • Added New diagrams explaining how the “application” interact in the Attribute Verifacation Process
  • Added New diagrams explaining more details on the implementation done in R24.08
  • Added description to explain the diagrams and processes
  • Added documentation about Certified Snapshot Credential (CSC) and Attribute Verification Record (AMR)
  • Added SAMM Aspect Models to indicate the semantics of the Different Credentials
  • Added definition of Cretified Data Credential (CDC) structure
  • Added definition of CSC structure -> Issued the first CSC Credential
  • Added definitions of purpose and structure from the ARM (Attribute Certification Record)
  • Add a new section to show the Schemas of the verification aspects
  • Added detailed description about the previous investigation and information about type level verification
  • Added explaination how the Digital Twin can be referenced technically
  • Added explanation on how the wallet interacts with the digital product pass app, and how it issues the credentials
  • Added reference the components (wallet, dpp-backend addon) and where the implementation “code” is located

Updated

  • Updated the v1.0 of the Verification Concept and identified improvements
  • Fixed incoherences and the feedback provided by Nick Landgrover
  • Refactored existing diagrams to give a clear view and explanation of the concept
  • Updated our first sequence diagrams, they are really outdated
  • Updated the aspect semantics and explain where to find documentation about the schemas

Issues Fixed

  • Fixed all the language typos in the Documentation (scanned with a tool)

PR Linked to:

Closes eclipse-tractusx/sig-release#651

@matbmoser matbmoser added documentation Improvements or additions to documentation DPP Verification Digital Product Pass Verification and Certification of Assets R24.08 labels Jul 8, 2024
@matbmoser matbmoser added this to the v4.0.0 milestone Jul 8, 2024
@matbmoser matbmoser self-assigned this Jul 8, 2024
@matbmoser matbmoser marked this pull request as draft July 8, 2024 13:56
@saudkhan116 saudkhan116 self-requested a review July 11, 2024 16:23
@matbmoser matbmoser force-pushed the docs/v2/verification branch from 8a2de16 to 1f4a488 Compare July 15, 2024 18:21
@matbmoser matbmoser force-pushed the docs/v2/verification branch from 1f4a488 to 8b98698 Compare July 15, 2024 18:22
@saudkhan116 saudkhan116 removed this from the v4.0.0-rc1 milestone Jul 19, 2024
@saudkhan116 saudkhan116 added this to the v4.0.0-rc2 milestone Jul 19, 2024
@matbmoser matbmoser marked this pull request as ready for review July 19, 2024 17:16
Copy link
Contributor

@saudkhan116 saudkhan116 left a comment

Choose a reason for hiding this comment

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

LGTM
Really appreciated, Good Job Mathias👍

@matbmoser
Copy link
Contributor Author

Thanks, was a lot of work :)

@matbmoser matbmoser merged commit 1191990 into main Jul 19, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation DPP Verification Digital Product Pass Verification and Certification of Assets R24.08
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DPP] Digital Product Pass Verification Documentation Update (R24.08)
2 participants