Skip to content

Commit fd95ded

Browse files
committed
Fix label schema link
This fixes the label schema link since the project is now archived and certificates are unlikely to be fixed. It also adjusts some markdown syntax with links at the end and whitespace after headers. Signed-off-by: Brandon Mitchell <[email protected]>
1 parent b5ec432 commit fd95ded

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

annotations.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Annotations
2+
23
Several components of the specification, like [Image Manifests](manifest.md) and [Descriptors](descriptor.md), feature an optional annotations property, whose format is common and defined in this section.
34

45
This property contains arbitrary metadata.
@@ -45,15 +46,15 @@ This specification defines the following annotation keys, intended for but not l
4546
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
4647
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
4748
* **org.opencontainers.image.base.name** Image reference of the image this image is based on (string)
48-
* This SHOULD be image references in the format defined by [distribution/distribution](https://github.com/distribution/distribution/blob/d0deff9cd6c2b8c82c6f3d1c713af51df099d07b/reference/reference.go).
49+
* This SHOULD be image references in the format defined by [distribution/distribution][distribution-reference].
4950
* This SHOULD be a fully qualified reference name, without any assumed default registry. (e.g., `registry.example.com/my-org/my-image:tag` instead of `my-org/my-image:tag`).
5051
* This SHOULD be the immediate image sharing zero-indexed layers with the image, such as from a Dockerfile `FROM` statement.
5152
* This SHOULD NOT reference any other images used to generate the contents of the image (e.g., multi-stage Dockerfile builds).
5253
* If the `image.base.name` annotation is specified, the `image.base.digest` annotation SHOULD be the digest of the manifest referenced by the `image.ref.name` annotation.
5354
5455
## Back-compatibility with Label Schema
5556
56-
[Label Schema](https://label-schema.org) defined a number of conventional labels for container images, and these are now superceded by annotations with keys starting **org.opencontainers.image**.
57+
[Label Schema][label-schema] defined a number of conventional labels for container images, and these are now superceded by annotations with keys starting **org.opencontainers.image**.
5758
5859
While users are encouraged to use the **org.opencontainers.image** keys, tools MAY choose to support compatible annotations using the **org.label-schema** prefix as follows.
5960
@@ -74,6 +75,7 @@ While users are encouraged to use the **org.opencontainers.image** keys, tools M
7475
| | `schema-version`| No equivalent in the OCI Image Spec |
7576
| | `docker.*`, `rkt.*` | No equivalent in the OCI Image Spec |
7677
77-
[spdx-license-expression]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60
78-
78+
[distribution-reference]: https://github.com/distribution/distribution/blob/d0deff9cd6c2b8c82c6f3d1c713af51df099d07b/reference/reference.go
79+
[label-schema]: https://github.com/label-schema/label-schema.org/blob/gh-pages/rc1.md
7980
[rfc3339]: https://tools.ietf.org/html/rfc3339#section-5.6
81+
[spdx-license-expression]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60

0 commit comments

Comments
 (0)