Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[tractusx-dev] Potential change to "Notice for Docker image" TRG
  • From: <sebastian.bezold@xxxxxxxxxxxxxxxxx>
  • Date: Thu, 18 Jan 2024 09:14:21 +0000
  • Accept-language: de-DE, en-US
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=mercedes-benz.com; dmarc=pass action=none header.from=mercedes-benz.com; dkim=pass header.d=mercedes-benz.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=MsbuKCLFZZW/XnLk20jUbkI3aW5cVOo50nwXS+5Lbkk=; b=gGjvbt9EMRj+BsJXszAKfZ2QIb1Vu3L9FkmaxEVwvlCXXFcbbxGlb3Fd+t8FoidMXRLmvP6jKgDQ5Zg7ZwwDgpjOJbDSS0rQLUM8yuALQFXLozaJMIajpFZNLRVMIPSacHL0fY1zr4g4aso/CuSAJenAR9IwG4Z9xJ6RM2a6cEzKLtsOryJPD5KGDA0C4AqSdMBxiItHFpn/E4TZvIAprD+o0BvG7i6nG9uAqQ5aA9ejEObcs6dfqW5EV5Q6YNgB1OvEsbyAmbzVBLjWflIrQBY5Ru93E91jN+KMfP+WdfALfGOHwSkh1vzCVeeJ0E7+OP29VSQAiHDnE+KEwIIvFw==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Go++y0odjR4xriVVSKqfyYQO6om8wtqbVs8Np1bbPS9tch9jzIp5Grli1t/TEP4HTYpJ5wP5ZLp1ivHrb0C3YeWOQaHP2+P7J6pBP7580k0OIPG0QzqQrv5xw2tfubb7DkdEHO3+AVNBnY1+CvVqd+QzMp/hnp14THCQRJcqjDzIOfGGbBuwqw/65iwOWmO8PU7tzlc70kKLgjjV+oD/lYoK/id/0Lp8IeYaDhfzSj1vZFcKNe/uxoH6xsqZl/AiGE4bex01zYWzjlcJ2VMsVS+LcyKktsh1innlTejonTa9+NWr288bFyFQVGOBk4Z9NOVWp5grjGcpG97PpEjH2w==
  • Delivered-to: tractusx-dev@xxxxxxxxxxx
  • List-archive: <https://www.eclipse.org/mailman/private/tractusx-dev/>
  • List-help: <mailto:tractusx-dev-request@eclipse.org?subject=help>
  • List-subscribe: <https://www.eclipse.org/mailman/listinfo/tractusx-dev>, <mailto:tractusx-dev-request@eclipse.org?subject=subscribe>
  • List-unsubscribe: <https://www.eclipse.org/mailman/options/tractusx-dev>, <mailto:tractusx-dev-request@eclipse.org?subject=unsubscribe>
  • Thread-index: AQHaSetNH/YZFj7/ikyrm+PwoHkE6w==
  • Thread-topic: Potential change to "Notice for Docker image" TRG

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.

Back to the top