Rewrite README based on image spec #233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdolitsky
force-pushed
the
readme-updates
branch
from
9cbcdac to
a98bcaf
Compare
jdolitsky
commented
Feb 3, 2021
README.md
Outdated
Comment on lines
19
to
39
| ## Distributing OCI Images and other content | ||
|
|
||
| The OCI Distribution Spec is closely related to the [OCI Image Format Spec project](https://github.com/opencontainers/image-spec), | ||
| the [OCI Runtime Spec project](https://github.com/opencontainers/runtime-spec), | ||
| and the [OCI Artifacts project](https://github.com/opencontainers/artifacts). | ||
|
|
||
| The Image Format Specification strictly defines the requirements for an OCI Image (container image), which consists of | ||
| a manifest, an optional image index, a set of filesystem layers, and a configuration. | ||
| The schema for OCI Image components is fully supported by the APIs defined in the Distribution Spec. | ||
|
|
||
| The OCI Runtime Specification defines how to properly run a container "[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)" | ||
| which fully adheres to the OCI Image Format. The Runtime Spec is relevant to the Distribution Spec in that they both support OCI Images, | ||
| and that container runtimes use the APIs defined in the Distribution Spec to fetch pre-built container images and run them. | ||
|
|
||
| The Distribution Spec is also designed generically enough to be leveraged as a distribution mechanism for | ||
| any type of content. The format of uploaded manifests, for example, need not necessarily adhere to the OCI Image Format | ||
| so long as it references the blobs which comprise a given artifact. | ||
|
|
||
| The OCI Artifacts project is an effort to provide guidance on how to | ||
| properly define and distribute content using the Distribution Spec for artifacts which are not container filesystem bundles, | ||
| in a way that is mostly compatible with the existing schemas defined in the Image Format Spec. |
There was a problem hiding this comment.
This is all new content. Tried to give the bigger picture
There was a problem hiding this comment.
For each paragraph in this section, I'd make the the specification being reference links, too.
The [OCI Image Format Specification] ...
The [OCI Runtime Specification] ...
The [OCI Distribution Spec] ...
The [OCI Artifacts] ...
[OCI Image Format Specification]: https://github.com/opencontainers/image-spec
[OCI Image Runtime Specification]: https://github.com/opencontainers/runtime-spec
[OCI Image Distribution Specification]: https://github.com/opencontainers/distribution-spec
[OCI Image Artifacts Specification]: https://github.com/opencontainers/artifacts
If we could get this section across all projects, that would be great.
There was a problem hiding this comment.
Also notice that I tried to be consistent with usage of "OCI" when formally naming things.
|
Looks really good to me, only a basic nitpick on the net-new content. |
|
@jzelinskie ty for review, back at ya |
Signed-off-by: Josh Dolitsky <[email protected]>
Signed-off-by: Josh Dolitsky <[email protected]>
Signed-off-by: Josh Dolitsky <[email protected]>
jdolitsky
force-pushed
the
readme-updates
branch
from
6f54774 to
e630d5b
Compare
|
CI passing now, ping @opencontainers/distribution-spec-maintainers |
|
LGTM |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Designed to look similar to https://github.com/opencontainers/image-spec/blob/master/README.md
Fixes #200