Skip to content

Commit

Permalink
Merge branch 'main' into docs/dpp-tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
matbmoser authored Dec 4, 2024
2 parents 1c2ed8d + de6fdd0 commit 4932bf2
Show file tree
Hide file tree
Showing 44 changed files with 1,652 additions and 656 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ The following people have contributed to this repository:
* Muhammad Saud Khan, CGI, https://github.com/saudkhan116
* Mathias Brunkow Moser, CGI, https://github.com/matbmoser
* Diogo Parracho, CGI, https://github.com/dsrparracho
* Erik Lebedkin, CGI, https://github.com/ELebedkin

Please add yourself to this list, if you contribute to the content.
52 changes: 41 additions & 11 deletions dpp-tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SPDX-License-Identifier: CC-BY-4.0
#######################################################################
-->

<div align=right><img height=200 src="../docs/media/dpp-tx-logo.png"/>&nbsp;&nbsp;<h1>Tractus-X​ Digital Product Passport​ Workstream​</h1><h4>Second Tractus-X Community Days - 16, 17 May 2024 - Stuttgart</h4></div>
<div align=right><img height=200 src="../docs/media/dpp-tx-logo.png"/>&nbsp;&nbsp;<h1>Tractus-X​ Digital Product Passport​ Workstream​</h1><h4>Third Tractus-X Community Days - 5,6 December 2024 - Stuttgart</h4></div>


## Description
Expand Down Expand Up @@ -55,30 +55,61 @@ You are one of the suppliers from Company-X. To maintain your client, you are re

Split into groups of five individuals, ensuring each group receives a sheet of paper containing a distinct Part from the [test-data](./resources/test-data/carParts.json).


> [!Caution]
> Please dont change the given templates for digital twin, only change the provided placeholders
For the tutorial, two distinct paths are available: the Explorer Path and the Builders Path, each tailored to different groups:

<div style="display: flex; justify-content: center; align-items: center; gap: 10px;">
<a href="./explorer-path.md">
<img src="./resources/screenshots/explorers.png" alt="explorers path" style="width: 30%;">
</a>
<a href="./builder-path.md">
<img src="./resources/screenshots/builders.png" alt="builders path" style="width: 30%;">
</a>
</div>

### 1. Explorer Path:

This path is ideal for individuals who aim to gain a high-level understanding of the overall logic and processes. It’s particularly suitable for business partners, decision-makers, or anyone interested in a functional overview.

- In this path, you will download pre-prepared requests, modify them, and execute them using Insomnia.
- This approach focuses on simplicity and provides an accessible introduction to the workflow.

&rarr; The Explorer Path can be accessed [here](./explorer-path.md)

### 2. Builders Path

This path is designed for technically inclined participants who want to dive deeper into the details.

- Clone the repository, follow the instructions in the ReadMe.md file, and navigate through various steps.
- Execute the HTTP requests directly via the terminal (Windows/Mac/Linux).
- This approach offers an in-depth exploration of the technical communication.

&rarr; The Builders Path can be accessed [here](./builder-path.md)

## Overview

## Phase 1: Data Provision

In this Phase, you as a provider will create a Digital Product Passport of a spectific Part of the Arena-X Car. For this phase, you can use your own computer through Visual Studio Code / Notepad ++ or a given Virtual Machine.
In this Phase, you as a provider will create a Digital Product Passport of a specific Part of the Arena-X Car. For this phase, you can use your own computer through Visual Studio Code / Notepad ++ or a given Virtual Machine.

##### Duration: 45 mins

The following steps provide a concise overview of the entire tutorial process, which you will primarily complete using the explorers or the developer path

#### Step 1 - Create a Digital Product Passport (DPP)

In this step, you'll create the Digital Product Passport (DPP) by utilizing data from the Product Carbon Footprint and specifications of a specific car part from the Arena.

* Follow the tutorial on [How to create Aspect Model](./aspect-model.md)

#### Step 2 - Create a Digital Twin integrating the generated DPP as a submodel

In this step, you will create a Digital Twin of your provided Car part.

* Follow the tutorial on [How to create a Digital Twin](./digital-twin-provision.md)

#### Step 3 - Generate the QR Code

From this point onward, follow the steps regardless of the path you chose earlier.

* Follow the tutorial on [How to generate a QR code](./qr-code.md)

#### Step 4 - Print the QR-Code
Expand Down Expand Up @@ -169,10 +200,10 @@ Congratulations! You have completed the E2E Journey for Digital Product Pass
| How to Guides | Link |
| -------- | ----- |
| How to deploy DPP Application | [deployment.md](./deployment.md) |
| How to create Aspect Model | [aspect-model.md](./aspect-model.md) |
| How to create a Digital Twin | [digital-twin-provision](.digital-twin-provision.md) |
| How to generate a QR code | [qr-code.md](./qr-code.md) |
| DPP Data Consumption | [data-consumption.md](./data-consumption.md) |
| Explorer Path | [explorer-path](./explorer-path.md) |
| Builder Path | [builder-path](./builder-path.md) |

## NOTICE

Expand All @@ -182,5 +213,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses
- SPDX-FileCopyrightText: 2024 BMW AG
- SPDX-FileCopyrightText: 2024 CGI Deutschland B.V. & Co. KG
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/digital-product-pass

- Source URL: https://github.com/eclipse-tractusx/digital-product-pass
137 changes: 0 additions & 137 deletions dpp-tutorial/aspect-model.md

This file was deleted.

Loading

0 comments on commit 4932bf2

Please sign in to comment.