Skip to content

[Bug]: Policy type API Reference links redirect to stale or non-specific API documentation #2047

Description

@Suhani95

Page link

https://kyverno.io/docs/policy-types/validating-policy/
https://kyverno.io/docs/policy-types/mutating-policy/
https://kyverno.io/docs/policy-types/image-validating-policy/

Description

The documentation pages under src/content/docs/docs/policy-types/ contain mismatched and outdated API Reference hyperlinks.

While the documentation text and examples reference the current stable APIs (for example apiVersion: policies.kyverno.io/v1), the linked "API Reference" URLs point to old hardcoded release-1.14 / v1alpha1 references

Why this is a problem

  • User Confusion: Users looking for official API specifications may be shown outdated, experimental, or non-specific schema definitions that do not match current stable behavior.
  • Technical Debt: Hardcoded external deep-links and release-specific anchors can easily become stale as the Kyverno repository evolves.

Expected behavior

API Reference links should:

  • point to the current stable policies.kyverno.io/v1 API documentation
  • avoid stale release-* and v1alpha1 references
  • use stable internal documentation routing where possible
  • prefer policy-specific internal anchors/sections if available
  • otherwise fall back to the centralized /docs/crds/ reference page

Slack discussion

N/A

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions