kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.58k stars 14.48k forks source link

CRI API reference at Container Runtime page is stale #48257

Open SergeyKanzhelev opened 1 month ago

SergeyKanzhelev commented 1 month ago

This is a Bug Report

/sig node /kind bug /priority important-soon /help

Problem: This page https://kubernetes.io/docs/setup/production-environment/container-runtimes/#cri-versions suggests that v1alpha2 is still supported. However it was not a case for a few versions now.

Also this page https://kubernetes.io/docs/concepts/architecture/cri/ links the quite old CRI API proto page. Simply pointing on master branch should be better unless we want to keep bumping the link for each release.

Proposed Solution:

Page to Update:

k8s-ci-robot commented 1 month ago

@SergeyKanzhelev: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/kubernetes/website/issues/48257): >**This is a Bug Report** > >/sig node >/kind bug >/priority important-soon >/help > >**Problem:** > > >**Proposed Solution:** > >**Page to Update:** >https://kubernetes.io/... > > > > > > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
tengqm commented 1 month ago

/triage accepted

thisisharrsh commented 1 month ago

I would like to work on this issue.

thisisharrsh commented 1 month ago

/assign

thisisharrsh commented 1 month ago

We need to correct both statements here, as they are misleading. They suggest that users can rely on v1alpha2, which is incorrect because v1alpha2 has been deprecated and should not be used as a fallback.

https://github.com/kubernetes/website/blob/92fad835876907c333dc185fcc78aa7545aa5de5/content/en/docs/setup/production-environment/container-runtimes.md?plain=1#L172-L179

sftim commented 1 month ago

This is important, but: /remove-priority important-soon /priority important-longterm

The issues at https://github.com/kubernetes/website/issues?q=is%3Aissue+is%3Aopen+label%3Apriority%2Fimportant-soon are the ones we really want to focus on.

SergeyKanzhelev commented 1 month ago

sorry, didn't mean to hijack your prioritization. I was mostly thought from severity perspective as the info we give is incorrect for a few releases already.

thisisharrsh commented 1 month ago

The issue is fixed here: https://github.com/kubernetes/website/pull/48398