Skip to content

Commit 6a649ba

Browse files
committed
add links for each spec, consistent OCI usage
Signed-off-by: Josh Dolitsky <[email protected]>
1 parent c4e7ea9 commit 6a649ba

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,34 @@ The _optional_ and _base_ layers of all OCI projects are tracked in the [OCI Sco
1818

1919
## Distributing OCI Images and other content
2020

21-
The OCI Distribution Spec is closely related to the [OCI Image Format Spec project](https://github.com/opencontainers/image-spec),
22-
the [OCI Runtime Spec project](https://github.com/opencontainers/runtime-spec),
23-
and the [OCI Artifacts project](https://github.com/opencontainers/artifacts).
21+
The OCI Distribution Spec is closely related to the [OCI Image Format Specification] project,
22+
the [OCI Runtime Specification] project,
23+
and the [OCI Artifacts] project.
2424

25-
The Image Format Specification strictly defines the requirements for an OCI Image (container image), which consists of
25+
The [OCI Image Format Specification] strictly defines the requirements for an OCI Image (container image), which consists of
2626
a manifest, an optional image index, a set of filesystem layers, and a configuration.
27-
The schema for OCI Image components is fully supported by the APIs defined in the Distribution Spec.
27+
The schema for OCI Image components is fully supported by the APIs defined in the OCI Distribution Specification.
2828

29-
The OCI Runtime Specification defines how to properly run a container "[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)"
30-
which fully adheres to the OCI Image Format. The Runtime Spec is relevant to the Distribution Spec in that they both support OCI Images,
31-
and that container runtimes use the APIs defined in the Distribution Spec to fetch pre-built container images and run them.
29+
The [OCI Runtime Specification] defines how to properly run a container "[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)"
30+
which fully adheres to the OCI Image Format Specification. The OCI Runtime Specification is relevant to the OCI Distribution Specification in that they both support OCI Images,
31+
and that container runtimes use the APIs defined in the OCI Distribution Specification to fetch pre-built container images and run them.
3232

33-
The Distribution Spec is also designed generically enough to be leveraged as a distribution mechanism for
34-
any type of content. The format of uploaded manifests, for example, need not necessarily adhere to the OCI Image Format
33+
The [OCI Distribution Specification] is also designed generically enough to be leveraged as a distribution mechanism for
34+
any type of content. The format of uploaded manifests, for example, need not necessarily adhere to the OCI Image Format Specification
3535
so long as it references the blobs which comprise a given artifact.
3636

37-
The OCI Artifacts project is an effort to provide guidance on how to
38-
properly define and distribute content using the Distribution Spec for artifacts which are not container filesystem bundles,
39-
in a way that is mostly compatible with the existing schemas defined in the Image Format Spec.
37+
The [OCI Artifacts] project is an effort to provide guidance on how to
38+
properly define and distribute content using the OCI Distribution Specification for artifacts which are not container filesystem bundles,
39+
in a way that is mostly compatible with the existing schemas defined in the OCI Image Format Specification.
40+
41+
[OCI Image Format Specification]: https://github.com/opencontainers/image-spec
42+
[OCI Runtime Specification]: https://github.com/opencontainers/runtime-spec
43+
[OCI Distribution Specification]: https://github.com/opencontainers/distribution-spec
44+
[OCI Artifacts]: https://github.com/opencontainers/artifacts
4045

4146
## FAQ
4247

43-
For questions about the Distribution Spec, please see the [FAQ](FAQ.md).
48+
For questions about the OCI Distribution Specification, please see the [FAQ](FAQ.md).
4449

4550
For general questions about OCI, please see the [FAQ on the OCI site](https://www.opencontainers.org/faq).
4651

0 commit comments

Comments
 (0)