opencontainers / opencontainers/image-spec

org.opencontainers.image.url label definition is ambiguous

Open
#802 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4.5k
Forks
891
Avg merge
27d 2h
Merged PRs (30d)
1

Description

The org.opencontainers.image.url label is defined as "URL to find more information on the image", but it is also documented as being compatible with label-schema, which defines this field as "URL of website with more information about the product or service provided by the container".

So in the OCI case, I could reasonably interpret this as a link to information about this image itself (not a link to the software provided by the image). I don't think that this is the intention, but the label-schema language is much clearer.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the definition and compatibility note for the org.opencontainers.image.url label described in this issue. Compare the current wording with the quoted label-schema definition and clarify whether the URL refers to the image itself or the software provided by the container. Done means the specification states the intended interpretation unambiguously.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.