Skip to content

Commit 9a7a48b

Browse files
authored
Merge pull request opencontainers#383 from coolljt0725/readme_one_sentence_per_line
README.md: one sentence per line
2 parents 6a6a6f2 + c16e487 commit 9a7a48b

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Open Container Initiative Image Format Specification
22

3-
The OCI Image Format project creates and maintains the software shipping container image format spec (OCI Image Format). The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.
3+
The OCI Image Format project creates and maintains the software shipping container image format spec (OCI Image Format).
4+
The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.
45

56
## Table of Contents
67

@@ -48,7 +49,10 @@ The _optional_ and _base_ layers of all OCI projects are tracked in the [OCI Sco
4849

4950
## Running an OCI Image
5051

51-
The OCI Image Format partner project is the [OCI Runtime Spec project](https://github.com/opencontainers/runtime-spec). The Runtime Specification outlines how to run a "[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)" that is unpacked on disk. At a high-level an OCI implementation would download an OCI Image then unpack that image into an OCI Runtime filesystem bundle. At this point the OCI Runtime Bundle would be run by an OCI Runtime.
52+
The OCI Image Format partner project is the [OCI Runtime Spec project](https://github.com/opencontainers/runtime-spec).
53+
The Runtime Specification outlines how to run a "[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)" that is unpacked on disk.
54+
At a high-level an OCI implementation would download an OCI Image then unpack that image into an OCI Runtime filesystem bundle.
55+
At this point the OCI Runtime Bundle would be run by an OCI Runtime.
5256

5357
This entire workflow supports the UX that users have come to expect from container engines like Docker and rkt: primarily, the ability to run an image with no additional arguments:
5458

@@ -61,19 +65,24 @@ To support this UX the OCI Image Format contains sufficient information to launc
6165

6266
**Q: Why doesn't this project mention distribution?**
6367

64-
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.
68+
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).
69+
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.
6570

6671
**Q: Why a new project?**
6772

68-
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.
73+
A: The [first OCI spec](https://github.com/opencontainers/runtime-spec) centered around defining the run side of a container.
74+
This is generally seen to be an orthogonal concern to the shipping container component.
75+
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.
6976

7077
**Q: Why work on this?**
7178

72-
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.
79+
A: We are seeing many independent implementations of container image handling including build systems, registries, and image analysis tools.
80+
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.
7381

7482
**Q: What happens to AppC or Docker Image Formats?**
7583

76-
A: Existing formats can continue to be a proving ground for technologies, as needed. The OCI Image Format project strives to provide a dependable open specification that can be shared between different tools and be evolved for years or decades of compatibility; as the deb and rpm format have.
84+
A: Existing formats can continue to be a proving ground for technologies, as needed.
85+
The OCI Image Format project strives to provide a dependable open specification that can be shared between different tools and be evolved for years or decades of compatibility; as the deb and rpm format have.
7786

7887
## Roadmap
7988

0 commit comments

Comments
 (0)