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 deprecated ADDITIONAL_OCI_ARTIFACT_TYPES #1590

Merged

Conversation

git-hyagi
Copy link
Contributor

closes: #1537

Copy link
Member

@lubosmj lubosmj left a comment

Choose a reason for hiding this comment

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

Please, rename CHANGES/1537.misc to CHANGES/1537.removal.

We want to remove the documentation from docs/workflows/oci-artifacts.rst too.

@git-hyagi git-hyagi force-pushed the remove-deprecated-ADDITIONAL_OCI_ARTIFACT_TYPES branch from 846807e to 76f6a08 Compare April 15, 2024 13:44
lubosmj
lubosmj previously approved these changes Apr 16, 2024

.. _default-oci-types:

By default the following list of media types is enabled in the Container Registry::
Copy link
Member

Choose a reason for hiding this comment

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

I would not remove entirely this file and leave a section in documentation stating that we are an OCI artifact registry. I would reword some of these docs with few examples what kind of additional to regular mediatypes we support ( out of the box) so it is clear for the end user that we are not just container but also artifact registry.

Copy link
Member

Choose a reason for hiding this comment

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

How about we mention this information on our landing page (https://docs.pulpproject.org/pulp_container/)? I do not think it is necessary to have a dedicated page for it.

Copy link
Member

Choose a reason for hiding this comment

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

I could be going both ways, however my preference would be to have it in a separate page for better readability and not cluttering the landing page
Example https://docs.docker.com/docker-hub/oci-artifacts/

Copy link
Member

Choose a reason for hiding this comment

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

@git-hyagi, do you think we should keep this doc section? If so, we may want to revisit the paragraphs and state clearly that we support OCI Artifacts, e.g., by referencing helm charts and providing more insights into what a generic OCI Artifact might look like. Of course, omitting the removed setting.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am in favor of keeping this doc section and rewriting the paragraphs to make it clear that this not just a container registry.

@ipanova ipanova dismissed their stale review April 16, 2024 09:39

Did not mean to make it a blocking comment but my feedback still stands

@lubosmj lubosmj dismissed their stale review April 23, 2024 15:10

It is still unclear whether we will leave docs/workflows/oci-artifacts.rst removed or not.

@git-hyagi git-hyagi force-pushed the remove-deprecated-ADDITIONAL_OCI_ARTIFACT_TYPES branch from 76f6a08 to 719dde5 Compare April 29, 2024 19:10
Copy link
Member

@lubosmj lubosmj left a comment

Choose a reason for hiding this comment

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

Thanks for opening this PR! 🧑‍🍳

@lubosmj lubosmj merged commit 288bf78 into pulp:main Apr 30, 2024
16 checks passed
@git-hyagi git-hyagi deleted the remove-deprecated-ADDITIONAL_OCI_ARTIFACT_TYPES branch June 18, 2024 16:12
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.

Deprecate ADDITIONAL_OCI_ARTIFACT_TYPES in favour of more relaxed schema validation
3 participants