spec: consistent wording #641
Conversation
|
fair |
spec.md
Outdated
| * [Image Index](image-index.md) - An index of annotated image manifests distributed as a complete unit. | ||
| * [Image Layout](image-layout.md) - The filesystem layout representing the contents of an image | ||
| * [Image Manifest](manifest.md) - a document describing the components that make up a container image | ||
| * [Image Index](image-index.md) - an index of annotated image manifests distributed as a complete unit |
There was a problem hiding this comment.
“an index of annotated image manifests” → “an annotated index of image manifests”? The index has annotated descriptors pointing at image manifests; whether the manifests themselves contain annotations doesn't really matter here.
And I'd rather drop “complete unit”, since the presence of an index is really about indexing multiple things, and not about whether the DAGs referenced from the index are present in the same CAS engine.
spec.md
Outdated
| * [Filesystem Layers](layer.md) - changesets that describe a container's filesystem | ||
| * [Image Configuration](config.md) - The document determining layer ordering and configuration of the image suitable for consumption by runtime-spec | ||
| * [Descriptors](descriptor.md) - Describes the type, metadata and content address of referenced content. | ||
| * [Image Configuration](config.md) - a document determining layer ordering and configuration of the image suitable for consumption by [runtime-spec][] |
There was a problem hiding this comment.
runtime-spec isn't really the consumer (that would probably be the runtime implementation). How about:
… suitable for translation into a [runtime bundle][…].
spec.md
Outdated
| * [Image Configuration](config.md) - The document determining layer ordering and configuration of the image suitable for consumption by runtime-spec | ||
| * [Descriptors](descriptor.md) - Describes the type, metadata and content address of referenced content. | ||
| * [Image Configuration](config.md) - a document determining layer ordering and configuration of the image suitable for consumption by [runtime-spec][] | ||
| * [Descriptors](descriptor.md) - an reference that describes the type, metadata and content address of referenced content |
There was a problem hiding this comment.
Everything else in this list is singular. How about:
- Descriptor - a reference that describes…
There was a problem hiding this comment.
I don't think "an reference" is correct english, is it?
Chasing opencontainers#621, standardise on case/punctuation/articles Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
|
thanks for the suggestions, should be good to go now |
|
LGTM |
| * [Image Configuration](config.md) - The document determining layer ordering and configuration of the image suitable for consumption by runtime-spec | ||
| * [Descriptors](descriptor.md) - Describes the type, metadata and content address of referenced content. | ||
| * [Image Manifest](manifest.md) - a document describing the components that make up a container image | ||
| * [Image Index](image-index.md) - an annotated index of one or more image manifests |
There was a problem hiding this comment.
“one or more” is not accurate; we explicitly allow manifests to be empty. This allows you to do things like distribute an image-layout which only provides CAS blobs.
|
LGTM |
Fixing overly-strict wording from 0cc871e (spec: consistent wording, opencontainers#641). In image-index.md, we explicitly allow 'manifests' to be empty: While this property MUST be present, the size of the array MAY be zero. Which allows you to do things like distribute an image-layout which only provides CAS blobs. Signed-off-by: W. Trevor King <wking@tremily.us>
Fixing overly-strict wording from 0cc871e (spec: consistent wording, opencontainers#641). In image-index.md, we explicitly allow 'manifests' to be empty: While this property MUST be present, the size of the array MAY be zero. Which allows you to do things like distribute an image-layout which only provides CAS blobs. Signed-off-by: W. Trevor King <wking@tremily.us>
Chasing #621, standardise on case/punctuation/articles
Signed-off-by: Jonathan Boulle jonathanboulle@gmail.com