README: update to include introductory information #86
Conversation
|
@duglin What do you think? Does this help? |
|
|
||
| The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers. | ||
| 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 create interoperable tools for building, transporting, and preparing a container image to run. |
There was a problem hiding this comment.
s/...is to create interoperable.../...is to enable the creation of interoperable.../
|
@philips yes this helps a lot. Just a few minor comments, in here and in the gdoc. But overall its a big improvement - thanks. |
|
More improvements based on the latest google docs and @wking suggestion to add the config: https://github.com/philips/image-spec/blob/a40ab64d670bd5a2eba6cd573e874105fd512776/README.md |
philips
force-pushed
the
improve-readme
branch
2 times, most recently
from
c0a8cbf to
20fe6a2
Compare
|
|
||
| This OCI project is tasked with creating a software shipping container image format spec (OCI Image Format) with security and naming as components. | ||
| This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a [filesystem serialization](serialization.md), and an [image configuration](serialization.md#image-json-description). At a high level the manifest contains metadata about the contents and dependencies of the image including the content-addressable identity of one or more filesystem serialization archives that will be unpacked to make up the final runnable filesystem. While the image configuration includes information such as application arguments, environments, etc. The combination of the image manifest, image configuration, and one or more filesystem serializations is called the "OCI Image". |
There was a problem hiding this comment.
s/the manifest/the image manifest/
s/While t/The/
|
Seems OK at a high level. I think we can land it and iterate as things develop. |
|
@jonboulle thanks for the fixes. Addressed. |
Include some diagrams and more introductory text to make the spec more approachable. This is designed to close out: opencontainers#69 Please comment on this doc if you feel changes should be made. Once everyone is happy with it I will fix up the PR and merge: https://docs.google.com/document/d/1qvbxydeauQAf9QpO9Vs-PRoN_QlYTrq86Z2OmniC3P0/edit Image documents: https://docs.google.com/drawings/d/1CUx_PsHddk5cgwkEZAj69QxUW0xKzjIPmo5VIY5QMp4/edit https://docs.google.com/drawings/d/1cYRHLBq3b7fTDeuLsXg1htr4B9eeORc3XATzJuK-YiM/edit Signed-off-by: Brandon Philips <brandon.philips@coreos.com>
philips
force-pushed
the
improve-readme
branch
2 times, most recently
from
1c080ee to
74114b7
Compare
|
Github caught up. Ready for an LGTM @opencontainers/image-spec-maintainers |
|
|
||
| ## Initial Proposal | ||
|  |
There was a problem hiding this comment.
have you tested make docs with this?
I'm thinking this may need to be inline base64, just like the media-types.png
|
LGTM, though the images will likely break the |
Include some diagrams and more introductory text to make the spec more
approachable. This is designed to close out:
#69
Please comment on this doc if you feel changes should be made. Once
everyone is happy with it I will fix up the PR and merge:
https://docs.google.com/document/d/1qvbxydeauQAf9QpO9Vs-PRoN_QlYTrq86Z2OmniC3P0/edit
Image documents:
https://docs.google.com/drawings/d/1CUx_PsHddk5cgwkEZAj69QxUW0xKzjIPmo5VIY5QMp4/edit
https://docs.google.com/drawings/d/1cYRHLBq3b7fTDeuLsXg1htr4B9eeORc3XATzJuK-YiM/edit