adds some description re: compat with docker schemas #268
Conversation
|
I would rather not duplicate information from the compatibility matrix. Can you just say "for a list of MIME types this is compatible with refer to the matrix?" |
|
I suppose I could say "for the MIME type that this is compatible with see the matrix." But this MIME type is only compatible with one other MIME type and, to me, it seems odd to make people jump to the "matrix" on a different page for the big reveal when the big reveal is just that OCI v1 = docker v2 wrt this MIME type. Maybe if more detail was provided in the matrix... |
mikebrow
force-pushed
the
add-links-to-compatibility-matrix
branch
from
5f50740
to
dc450a2
Compare
|
Updated to address comments. |
| @@ -22,7 +22,9 @@ A client will distinguish a manifest list from an image manifest based on the Co | |||
| - **`mediaType`** *string* | |||
|
|
|||
| This REQUIRED property contains the MIME type of the manifest list. | |||
| For this version of the specification, this MUST be set to `application/vnd.oci.image.manifest.list.v1+json`. | |||
| For this version of the specification, this MUST be set to | |||
There was a problem hiding this comment.
The rest of the file is not wrapped but instead one-sentence-per-line (or one-paragraph-per-line), could you do similarly here?
There was a problem hiding this comment.
ok.. interesting style, updated to adhere to it. Out of curiosity is there a reason to not break sentences in a .md file?
There was a problem hiding this comment.
On Wed, Sep 07, 2016 at 10:50:50AM -0700, Mike Brown wrote:
- For this version of the specification, this MUST be set to
application/vnd.oci.image.manifest.list.v1+json.- For this version of the specification, this MUST be set to
ok.. interesting style, updated to adhere to it. Out of curiosity is
there a reason to not break sentences in a .md file?
There's a small bit of background in opencontainers/runtime-spec#82.
mikebrow
force-pushed
the
add-links-to-compatibility-matrix
branch
from
dc450a2
to
3b738d3
Compare
|
updated to adhere to non-wrapped style for sentences. |
| @@ -23,6 +23,7 @@ A client will distinguish a manifest list from an image manifest based on the Co | |||
|
|
|||
| This REQUIRED property contains the MIME type of the manifest list. | |||
| For this version of the specification, this MUST be set to `application/vnd.oci.image.manifest.list.v1+json`. | |||
| For the MIME type that this is compatible with see the [matrix](media-types.md#compatibility-matrix). | |||
There was a problem hiding this comment.
This doesn't have to be singular. And most of the rest of the spec uses the generic “media type” instead of the email-specific “MIME type”. So I'd suggest “MIME type” → “media types”.
There was a problem hiding this comment.
Yeah MIME was in the prior sentence already so I just ran with it. Will remove MIME type from the doc.
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
mikebrow
force-pushed
the
add-links-to-compatibility-matrix
branch
from
3b738d3
to
24c10ea
Compare
|
Update the document to adhere to using "media type" vs "MIME." |
|
24c10ea looks good to me.
|
|
LGTM |
|
lgtm |
Adding a couple links to remove confusion regarding OCI being at v1 and docker at v2 for "fat" manifest lists and distribution (image) manifests.
Signed-off-by: Mike Brown brownwm@us.ibm.com