search

eclipse-tractusx / digital-product-pass

Eclipse Tractus-X Digital Product Pass - An application for visualizing Digital Product Passports, Battery Passports and Transmission Passports, it is the reference implementation of the EcoPass KIT
https://github.com/eclipse-tractusx/digital-product-pass
Apache License 2.0
26 stars 17 forks source link

TRG 7.07 / TRG 7.08: Please provide information for images in documentation #399

Closed tom-rm-meyer-ISST closed 4 months ago

tom-rm-meyer-ISST commented 4 months ago

Current Behavior

Self-created content does not explictly reference the license. Example: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/interoperability/media/graphBusinessProblem.svg

Expected Behavior

Following TRG 7.07 one should license self-created images with CC-BY 4.0. It links to TRG 7.08 that proposes to place the license file directly next to it with {same name with file extension}.license.

matbmoser commented 4 months ago

Hi @tom-rm-meyer-ISST,

Thank you for creating the ticket! Our Application is no KIT as you may know: https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-08/#self-created-content. The .md file mentions already the Notice https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/interoperability/InteroperabilityGuide.md#notice

Note that the TRG is for KITs, not for product repositories.

I understand that the .license is something important, and I have used this already in other parts of the repo also, since its a good practice, example: https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification/resources/implementation

If the TRG is not really clear and you want to propose that all the repos should have that, go ahead and I will support that, I also think is a good practice, however right now its not enforced for product repositories.

tom-rm-meyer-ISST commented 4 months ago

Hi @tom-rm-meyer-ISST,

Thank you for creating the ticket! Our Application is no KIT as you may know: https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-08/#self-created-content. The .md file mentions already the Notice https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/interoperability/InteroperabilityGuide.md#notice

Note that the TRG is for KITs, not for product repositories.

I understand that the .license is something important, and I have used this already in other parts of the repo also, since its a good practice, example: https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification/resources/implementation

If the TRG is not really clear and you want to propose that all the repos should have that, go ahead and I will support that, I also think is a good practice, however right now its not enforced for product repositories.

Ah, missed to check that notice file!

Regarding TRG 7.08: It's linked from TRG 7.07 with "Self-created content like images should have the copyright and license information included, where ever possible. Images should go under the CC-BY-4.0. See TRG 7.08".

Thus, the handling should be the same for applications.

Maybe we should discuss this in the Committer Meeting? Likely we should refine the TRG a little bit. I was confused in the beginning and discussed it with @mhellmeier - we came to the KIT way conclusion :)

matbmoser commented 4 months ago

@tom-rm-meyer-ISST image

It really clear that the TRG is for KITs, not for product repositories.

But sure lets propose that in the committer meeting. I think is a good idea to have it also for the products 💯

I will close this ticket then ;) :octocat:

mhellmeier commented 4 months ago

I think talking about it during the next office hour or at the Committer Meeting sounds good.