-
Notifications
You must be signed in to change notification settings - Fork 206
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove detail.md #280
Remove detail.md #280
Conversation
CC: @dmcgowan |
This was created during #178 and is referenced from the spec.md as:
which could be why it is wrong, but also is not immediately obvious that it is obsolete historical context |
I mean, isn't that what git history is for? Docs that were at one point relevant. I think that the current state is far enough away from the behaviour of the spec, that it's not immediately useful, without destroying potentially useful context, and it's really difficult to figure out what's useful vs. what's not useful. Specifically, a lot of the described failure modes are not actually discussed, or dictated by the spec. In addition, it has a lot of "extra" information, like authentication in it, that's not touched at in the "official" spec at all, and if you remove that from an example, then some of the described responses (which are actually valid failure modes in response to that) are no longer useful. I'm basically saying that it's a document that while "accurate" for describing how a registry might work, the descriptions in the doc are far outside of the specification. |
yes. So, in addition to this PR, I would update this line of the |
@vbatts Done. |
Although detail.md contained some useful information, the majority of the document contained information that wasn't relevant to a generic OCI registry. It contained extraneous information, like information about authentication that many registries may not use. In addition, the defined behaviours were not conformant to the specification. The spec still has a permalink to a github version of the detail.md. Signed-off-by: Sargun Dhillon <[email protected]>
cc @pmengelbert to H/T acknowledge his work :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Although detail.md contained some useful information, the majority
of the document contained information that wasn't relevant to a
generic OCI registry.
It contained extraneous information, like information about authentication
that many registries may not use. In addition, the defined behaviours
were not conformant to the specification.
Signed-off-by: Sargun Dhillon [email protected]