kubernetes
Stale declarative validation page intro
This is a Bug Report
Problem: The start of https://kubernetes.io/docs/reference/using-api/declarative-validation/ talks about declarative validation being enabled for ReplicationController. This is a true statement, but it's getting to be stale enough that it might be misleading.
Proposed Solution: Write a new introduction for https://kubernetes.io/docs/reference/using-api/declarative-validation/
Page to Update: https://kubernetes.io/docs/reference/using-api/declarative-validation/
Additional Information: /sig api-machinery /priority backlog
@jpbetz FYI
Hi @lmktfy! I'd like to take this on.
Looking at the current intro, I can see the staleness you mentioned—ReplicationController as the sole example does feel outdated, and the Note explaining why it's there has a bit of a defensive tone.
Before I draft changes, a couple quick questions:
-
ReplicationController example: Should we remove this entirely and focus on the mechanism itself, or replace it with modern APIs that have adopted declarative validation? If there's a longer list now, I'm happy to include those.
-
Intro structure: Any preference on leading with benefits/use cases vs. diving straight into the technical details?
Let me know your thoughts. Thank you!
/triage accepted
ReplicationController example
The work you need to do includes figuring out the approach to take.
Intro structure: Any preference on leading with benefits/use cases vs. diving straight into the technical details?
No preference.
Given that Declarative Validation adoption is still evolving, it may be better for the introduction to avoid specific API examples and instead focus on explaining the mechanism and its intended benefits.
