Re: [tractusx-dev] Potential change to "Notice for Docker image" TRG

[<sebastian.bezold@xxxxxxxxxxxxxxxxx>]

HI all,

 

following up on that, i prepared a first adaptation of the TRG: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/pull/629

Please let me know what you think, so we can improve it, until we reach a final new version of this TRG

 

Best regards

Sebastian

 

Von: tractusx-dev <tractusx-dev-bounces@xxxxxxxxxxx> im Auftrag von carsten.lenz--- via tractusx-dev <tractusx-dev@xxxxxxxxxxx>
Datum: Montag, 22. Januar 2024 um 08:22
An: tractusx-dev@xxxxxxxxxxx <tractusx-dev@xxxxxxxxxxx>
Cc: Lenz, Carsten (415) <carsten.lenz@xxxxxxxxxxxxxxxxx>
Betreff: Re: [tractusx-dev] Potential change to "Notice for Docker image" TRG

[**EXTERNAL E-MAIL**]

Hey Sebastian,

hey list,

I’d also vote for a dedicated Markdown file for the Docker Notice. As mentioned in recent Office Hour there is one point I want to mention:

 

Docker Hub has content limits. This is also mentioned in the GH Action recommended in our TRGs: https://github.com/peter-evans/dockerhub-description#content-limits

 

In case a product has a very detailed repositories README.md file there could be the possibility that our Docker Notice, which is added to the end of the README.md file could be cut off not be visible at Docker Hub, which we must avoid. Placing the Docker Notice section on top of repositories README.md file is no option here.

 

Cheers

Carsten

 

Von: tractusx-dev <tractusx-dev-bounces@xxxxxxxxxxx> im Auftrag von "sebastian.bezold--- via tractusx-dev" <tractusx-dev@xxxxxxxxxxx>
Antworten an: tractusx developer discussions <tractusx-dev@xxxxxxxxxxx>
Datum: Donnerstag, 18. Januar 2024 um 10:15
An: "tractusx-dev@xxxxxxxxxxx" <tractusx-dev@xxxxxxxxxxx>
Cc: Sebastian Bezold <sebastian.bezold@xxxxxxxxxxxxxxxxx>
Betreff: [tractusx-dev] Potential change to "Notice for Docker image" TRG

 

[**EXTERNAL E-MAIL**]

Hi all,

 

the Consortia System Team is currently thinking about a potential adjustment of our TRG 4.06 – Notice for docker images.

 

This TRG describes a necessary section with information about our container base images, that we provide in our repositories and also on our container image pages on DockerHub.

The notice section is currently allowed to be contained in either the top-level README.md, or in a dedicated file, without any restrictions on where this file should be kept in the repo.

 

The potential change to the TRG, that I want to get your opinion on, before providing a change proposal is the following:

 

We want to ALWAYS have the Notice for docker image section in a DEDICATED file instead of the top-level README.md.

The top-level README.md should still link the the notice (or notices in case you publish more than one image).

 

I see the following advantages in this:

• A dedicated markdown file, that is pushed as DockerHub description can be much better adapted for the specific audience than the repo README.md
  Only “how to use this image” instead of also “how to setup local repo” for example
• Emphasis on important things like “use on your own risk” disclaimers are more prominent and don’t get lost in a long README.md

 

So all in all, I think there would be some benefits, with only small amount of work for the repos that have their notice in the top-level README.md

 

But what do you think? Does it make sense to make this mandatory by adapting the TRG?

 

Thanks for your feedback!

 

Sebastian

If you are not the addressee, please inform us immediately that you have received this e-mail by mistake, and delete it. We thank you for your support.

 

If you are not the addressee, please inform us immediately that you have received this e-mail by mistake, and delete it. We thank you for your support.

 

If you are not the addressee, please inform us immediately that you have received this e-mail by mistake, and delete it. We thank you for your support.