kubernetes: Many links in API documentation broken

What happened: There are many spots in API comments that are broken (pointing to https://git.k8s.io/community/contributors/devel/api-conventions.md). One example is here: https://github.com/kubernetes/api/blob/master/core/v1/types.go#L3491, a quick search for that URL currently shows 84 results on github (however this is obviously including generated files too)

These lead to broken user-facing doc links, such as in oc explain in OpenShift

What you expected to happen: I’m assuming these are supposed to be updated to https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

About this issue

  • Original URL
  • State: closed
  • Created 5 years ago
  • Reactions: 1
  • Comments: 15 (10 by maintainers)

Most upvoted comments

Yes, https://github.com/kubernetes/kubernetes/pull/74245 seems to have stalled. If you want to start with that PR, fixup the verify failures with a second commit of your own, and open a new PR, that would be great

Stale issue? Still open to contribution?