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

[Industry Core KIT] doc: added new unique id push notification illustration #1057

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Oct 16, 2024

Description

Enhancement of the existing documentation for the unique id push notifications with a new illustration to describe the functionality of the notifications in a visual way. For detailed information have a look at the changelog.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@johannsvarela johannsvarela self-assigned this Oct 17, 2024
@johannsvarela johannsvarela added the documentation Improvements or additions to documentation label Oct 17, 2024
@eckardg eckardg self-requested a review October 17, 2024 15:47
Copy link
Contributor

@eckardg eckardg left a comment

Choose a reason for hiding this comment

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

Thanks!

@stephanbcbauer
Copy link
Member

@johannsvarela THX for this contribution ⇾ one question related to the picture. Is this just an exported SVG? Or could it also directly be adapted? Question ⇾ where are the sources, if someone from the open-source community want to adapt the picture.

Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

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

As @stephanbcbauer mentioned,

  • please provide the "raw" file like the drawio
  • please add a dedicated license file for the svg and raw file (TRG 7.08) -> same location and same name and append .license (content as mentioned in the trg with your companies that created the image OR just the contributors to the ef)

Sidequestion to the image: Does it make sense to state the direction in terms of the bom (bom, usage) as we're trying to build / update that semantic model?

@eckardg
Copy link
Contributor

eckardg commented Oct 18, 2024

@tom-rm-meyer-ISST: Question to your sidequestion: do you want to add an information where the singlelevelbom (=at customer) and where the singlelevelusage (=at supplier) is maintained? Or do you have something else in mind?

@johannsvarela
Copy link
Contributor Author

johannsvarela commented Oct 18, 2024

Sidequestion to the image: Does it make sense to state the direction in terms of the bom (bom, usage) as we're trying to build / update that semantic model?

@stephanbcbauer @tom-rm-meyer-ISST unlike png files, this svg file of the image can be inserted and adapted directly into tools such as drwa.io. I would therefore not add an additional raw file.

If you still insist, I'm happy to add that, but this file would never be used in KIT, but would only remain in the asset folder as an additional file.

@johannsvarela
Copy link
Contributor Author

As @stephanbcbauer mentioned,

  • please provide the "raw" file like the drawio
  • please add a dedicated license file for the svg and raw file (TRG 7.08) -> same location and same name and append .license (content as mentioned in the trg with your companies that created the image OR just the contributors to the ef)

Sidequestion to the image: Does it make sense to state the direction in terms of the bom (bom, usage) as we're trying to build / update that semantic model?

@tom-rm-meyer-ISST i'm not sure if i get your point of your sidequest? 😅

@stephanbcbauer
Copy link
Member

stephanbcbauer commented Oct 18, 2024

Sidequestion to the image: Does it make sense to state the direction in terms of the bom (bom, usage) as we're trying to build / update that semantic model?

@stephanbcbauer @tom-rm-meyer-ISST unlike png files, this svg file of the image can be inserted and adapted directly into tools such as drwa.io. I would therefore not add an additional raw file.

If you still insist, I'm happy to add that, but this file would never be used in KIT, but would only remain in the asset folder as an additional file.

Ah cool, sorry didnt test it if it is possible to open in draw.io -> it works (my concern was, not all SVG are editable in drawio

image

and its also mentioned in the svg file

<!-- Do not edit this file with editors other than draw.io -->

thx for adding the license file

Comment on lines +4 to +14
- SPDX-FileCopyrightText: 2023 BASF SE
- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
- SPDX-FileCopyrightText: 2023 German Edge Cloud GmbH & Co. KG
- SPDX-FileCopyrightText: 2023 Mercedes Benz AG
- SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH
- SPDX-FileCopyrightText: 2023 SAP SE
- SPDX-FileCopyrightText: 2023 Siemens AG
- SPDX-FileCopyrightText: 2023 T-Systems International GmbH
- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
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
- SPDX-FileCopyrightText: 2023 BASF SE
- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
- SPDX-FileCopyrightText: 2023 German Edge Cloud GmbH & Co. KG
- SPDX-FileCopyrightText: 2023 Mercedes Benz AG
- SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH
- SPDX-FileCopyrightText: 2023 SAP SE
- SPDX-FileCopyrightText: 2023 Siemens AG
- SPDX-FileCopyrightText: 2023 T-Systems International GmbH
- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
- SPDX-FileCopyrightText: 2024 BASF SE
- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
- SPDX-FileCopyrightText: 2024 German Edge Cloud GmbH & Co. KG
- SPDX-FileCopyrightText: 2024 Mercedes Benz AG
- SPDX-FileCopyrightText: 2024 Robert Bosch Manufacturing Solutions GmbH
- SPDX-FileCopyrightText: 2024 SAP SE
- SPDX-FileCopyrightText: 2024 Siemens AG
- SPDX-FileCopyrightText: 2024 T-Systems International GmbH
- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation

If you really created the image in 2023, ignore and resolve this comment. Else you can just commit the update to 2024.

@tom-rm-meyer-ISST
Copy link
Contributor

tom-rm-meyer-ISST commented Oct 19, 2024

As @stephanbcbauer mentioned,

  • please provide the "raw" file like the drawio
  • please add a dedicated license file for the svg and raw file (TRG 7.08) -> same location and same name and append .license (content as mentioned in the trg with your companies that created the image OR just the contributors to the ef)

Sidequestion to the image: Does it make sense to state the direction in terms of the bom (bom, usage) as we're trying to build / update that semantic model?

@tom-rm-meyer-ISST i'm not sure if i get your point of your sidequest? 😅

@johannsvarela & @eckardg: my sidequestion was partially stupid as the information is partially available (after downloading the svg I can zoom :D ). When I recently read the IC KIT and this feature, I tried to think "OK which Connect-to-X do I need to for the bom and which for the usage direction?". For the usage you already state it in the middle of Connect-to-Child. To be more consistent I propose to update the upper middle text to something like "New DT has been created for a part and is available. The customer can update the singleLevelBillOfMaterial." (Note: I made it here an active tense sentence as they are easier to read concerning the "who does what" - you can also go for current passive tense as the actor is clear :) )

For me personaly I would also think about highlighting the model names (e.g. make them bold).

Nevertheless, I added one comment regarding the license year (might be even wrong). Just ping me for the approval afterwards (I'll be available till monday mid of the day).

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants