mini update 13: add "tag" definition by pmengelbert · Pull Request #176 · opencontainers/distribution-spec

pmengelbert · 2020-07-29T18:53:29Z

This PR is based on #175 .

See the relevant diff below:
https://github.com/bloodorangeio/distribution-spec/compare/mini-update-12...bloodorangeio:mini-update-13?expand=1

Signed-off-by: Josh Dolitsky <393494+jdolitsky@users.noreply.github.com>

…write Add initial spec rewrite as large html comment

Related to opencontainers#126 The following sections have been removed: - Changes - Historical Context (already in reorg) - Overview / Listing Repositories (unused catalog API) The following sections have been moved into commented reorg: - Notational Conventions ---> Definitions / Document Language - Overview / Errors ---> HTTP API / Error Codes - Overview / API Version Check ---> Conformance / Workflow Categories / Pull - Overview / Pulling An Image ---> Conformance / Workflow Categories / Pull - Overview / Pushing An Image ---> Conformance / Workflow Categories / Push - Overview / Listing Image Tags ---> Conformance / Workflow Categories / Content Discovery - Overview / Deleting an Image ---> Conformance / Workflow Categories / Content Management - Detail / Errors ---> HTTP API / Error Codes Signed-off-by: Josh Dolitsky <393494+jdolitsky@users.noreply.github.com>

It seemed like a good idea at first to reorganize things in a giant HTML comment, but it appears a failed strategy. Instead, going to piecemeal changes into spec.md itself, on the "reorg" branch. Then when everything ready, we can make a big PR from "reorg" onto "master". Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

This is a new table of contents for the spec, designed to add simplicity and organization. Existing content will later be moved into one of these sections, or removed entirely if considered superfluous. Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

Fill in the overview section, including new introduction referring to "content" (vs. just container images). Move historical context section underneath overview. Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

Fill in the definitions section, introducing several terms and defintions which will serve as reference for the rest of the document. Also moved the "notational conventions" section into this section, removing any language that seemed unnecessary or related to compliance (which will be covered in the conformance section). Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

Fill in conformance section, adding minimum requirements stating that all compliant registries must at least support Pull. Added a section regarding certification, linking to the opencontainers/oci-conformance repo. For the workflow sections, intentionally left blank, and will be added in a follow-up PR. Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

Signed-off-by: Peter Engelbert <pmengelbert@gmail.com>

It seemed like a good idea at first to reorganize things in a giant HTML comment, but it appears a failed strategy. Instead, going to piecemeal changes into spec.md itself, on the "reorg" branch. Then when everything ready, we can make a big PR from "reorg" onto "master". Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>

…nto HEAD Signed-off-by: jdolitsky <393494+jdolitsky@users.noreply.github.com>