Skip to content
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

Merged
merged 1 commit into from
Jun 22, 2021
Merged

Remove detail.md #280

merged 1 commit into from
Jun 22, 2021

Conversation

sargun
Copy link
Contributor

@sargun sargun commented Jun 17, 2021

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]

@sargun
Copy link
Contributor Author

sargun commented Jun 17, 2021

CC: @dmcgowan

@vbatts
Copy link
Member

vbatts commented Jun 17, 2021

This was created during #178 and is referenced from the spec.md as:

Historical document describing original API endpoints and requests in detail

which could be why it is wrong, but also is not immediately obvious that it is obsolete historical context

@sargun
Copy link
Contributor Author

sargun commented Jun 17, 2021

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.

@vbatts
Copy link
Member

vbatts commented Jun 18, 2021

yes. So, in addition to this PR, I would update this line of the spec.md to point to the v1.0 perma-url for that detail.md https://github.com/opencontainers/distribution-spec/blob/v1.0.0/detail.md or similar

@sargun
Copy link
Contributor Author

sargun commented Jun 18, 2021

@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]>
@vbatts
Copy link
Member

vbatts commented Jun 22, 2021

cc @pmengelbert to H/T acknowledge his work :-)

Copy link
Member

@vbatts vbatts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@dmcgowan dmcgowan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vbatts vbatts merged commit 4d893d7 into opencontainers:main Jun 22, 2021
@sargun sargun deleted the fix-detail branch June 22, 2021 21:18
@sargun sargun restored the fix-detail branch June 22, 2021 21:18
@sargun sargun deleted the fix-detail branch June 22, 2021 21:18
@jdolitsky jdolitsky mentioned this pull request Sep 15, 2022
@sudo-bmitch sudo-bmitch mentioned this pull request Feb 1, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants