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

docs(trg): make dedicated container image notice mandatory #629

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

SebastianBezold
Copy link
Contributor

Description

This PR is a follow up to a discussion on our mailing list.
The discussion is about making a dedicated "Notice for Docker image" mandatory and no longer allow it to be a section in the top-level README.md.
So far, there has only been feedback pro change.

TL;DR from the discussion:

  • Moving to a dedicated file is not a lot of work
  • Can be used to better address target audience
  • There is a character limit for DockerHub descriptions, which might cut off the mandatory notice section at the end of long repository README.md files

Fixes eclipse-tractusx/sig-infra#360

FaGru3n
FaGru3n previously approved these changes Jan 23, 2024
Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

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

LGTM only name for separate Docker notice.md could be discussed, i personally like the approach form "Country Risk" to name it "Docker_Notice.md"

docs/release/trg-4/trg-4-06.md Outdated Show resolved Hide resolved
docs/release/trg-4/trg-4-06.md Outdated Show resolved Hide resolved
docs/release/trg-4/trg-4-06.md Outdated Show resolved Hide resolved
Copy link
Contributor

@FaGru3n FaGru3n left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@carslen carslen left a comment

Choose a reason for hiding this comment

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

LGTM

@SebastianBezold SebastianBezold merged commit d533432 into main Feb 8, 2024
4 checks passed
@SebastianBezold SebastianBezold deleted the mandate-dedicated-docker-notice-file branch February 8, 2024 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TRG new: Docker file notice
4 participants