website icon indicating copy to clipboard operation
website copied to clipboard

[Enhancement] Add Overview/Summary for Each Major Rule Type in Kyverno Documentation

Open KhaledEmaraDev opened this issue 8 months ago • 0 comments

Description

To improve the usability and clarity of the Kyverno documentation, we should add an overview or summary for each of the four major rule types. This will help users quickly understand the purpose and functionality of each rule type. The rule types that need an overview or summary are:

  • [ ] Validate (@KhaledEmaraDev)
    • [ ] CEL (@MariamFahmy98)
  • [ ] Mutate (@eddycharly)
  • [ ] https://github.com/kyverno/website/issues/1288 (@realshuting )
  • [ ] Verify Images (@vishal-chdhry)

Additional Notes:

  • Each overview should be concise but comprehensive enough to give a clear understanding of the rule type.
  • Consider adding links to more detailed sections or external resources where users can find additional information.

Documentation Location:

The overviews should be added to the respective sections in the Kyverno documentation site under each rule type.

Slack discussion

No response

KhaledEmaraDev avatar Jun 12 '24 18:06 KhaledEmaraDev