Skip to content

Commit 7033fc2

Browse files
committed
README: clean-up and clarifications
- Remove redundant sentence describing media types document - Disambiguate "OCI Layers", and more directly explain link to archival format - Change ROADMAP pointer to a more realistic date - Minor tweaks to FAQ wording Signed-off-by: Jonathan Boulle <[email protected]>
1 parent 676ea7a commit 7033fc2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ Once built the OCI Image can then be discovered by name, downloaded, verified by
3434

3535
## Understanding the Specification
3636

37-
The [Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification. This document outlines the OCI Image file format specifications, including the [filesystem layer changesets](layer.md) and image manifest described above.
37+
The [OCI Image Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification.
3838

39-
The high level components of the spec include:
39+
The high-level components of the spec include:
4040

41-
* An [image manifest](manifest.md), a set of [filesystem layers](layer.md), and [image configuration](config.md) (base layer)
42-
* A process of hashing the image format for integrity and content-addressing (base layer)
43-
* Signatures that are based on signing image content address (optional layer)
44-
* Naming that is federated based on DNS and can be delegated (optional layer)
41+
* An archival format for container images, consisting of an [image manifest](manifest.md), an [image layout](image-layout.md), a set of [filesystem layers](layer.md), and [image configuration](config.md) (base OCI layer)
42+
* A process of hashing the image format for integrity and content-addressing (base OCI layer)
43+
* Signatures that are based on signing image content address (optional OCI layer)
44+
* Naming that is federated based on DNS and can be delegated (optional OCI layer)
4545

46-
The optional and base layers of all OCI projects are tracked in the [OCI Scope Table](https://www.opencontainers.org/governance/oci-scope-table).
46+
The _optional_ and _base_ layers of all OCI projects are tracked in the [OCI Scope Table](https://www.opencontainers.org/governance/oci-scope-table).
4747

4848
## Running an OCI Image
4949

@@ -60,13 +60,13 @@ To support this UX the OCI Image Format contains sufficient information to launc
6060

6161
**Q: Why doesn't this project mention distribution?**
6262

63-
A: Distribution, for example using HTTP as both Docker v2.2 and AppC do today, is currently out of scope on the [OCI Scope Table](https://www.opencontainers.org/governance/oci-scope-table). There has been [some discussion on the TOB mailing list]( https://groups.google.com/a/opencontainers.org/d/msg/tob/A3JnmI-D-6Y/tLuptPDHAgAJ) to make distribution an optional layer but this topic is a work in progress.
63+
A: Distribution, for example using HTTP as both Docker v2.2 and AppC do today, is currently out of scope on the [OCI Scope Table](https://www.opencontainers.org/governance/oci-scope-table). There has been [some discussion on the TOB mailing list](https://groups.google.com/a/opencontainers.org/d/msg/tob/A3JnmI-D-6Y/tLuptPDHAgAJ) to make distribution an optional layer, but this topic is a work in progress.
6464

6565
**Q: Why a new project?**
6666

67-
A: The first OCI spec centered around defining the run side of a container. This is generally seen to be an orthogonal concern to the shipping container component. As practical examples of this separation you see many organizations separating these concerns into different teams and organizations: the Docker Distribution project and the Docker containerd project; Amazon ECS and Amazon EC2 Container Registry, etc.
67+
A: The [first OCI spec][https://github.com/opencontainers/runtime-spec] centered around defining the run side of a container. This is generally seen to be an orthogonal concern to the shipping container component. As practical examples of this separation you see many organizations separating these concerns into different teams and organizations: the Docker Distribution project and the Docker containerd project; Amazon ECS and Amazon EC2 Container Registry, etc.
6868

69-
**Q: Why start this work now?**
69+
**Q: Why work on this?**
7070

7171
A: We are seeing many independent implementations of container image handling including build systems, registries, and image analysis tools. As an organization we would like to encourage this growth and bring people together to ensure a technically correct and open specification continues to evolve reflecting the OCI values.
7272

@@ -76,7 +76,7 @@ A: Existing formats can continue to be a proving ground for technologies, as nee
7676

7777
## Roadmap
7878

79-
The [GitHub milestones](https://github.com/opencontainers/image-spec/milestones) lays out the path to the OCI v1.0.0 release in June 2016.
79+
The [GitHub milestones](https://github.com/opencontainers/image-spec/milestones) lay out the path to the OCI v1.0.0 release in late 2016.
8080

8181
# Contributing
8282

0 commit comments

Comments
 (0)