kubernetes-sigs/kubectl-validate

Document Overlay Schemas

Open

#52 opened on May 31, 2023

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Go (56 forks)auto 404
good first issue

Repository metrics

Stars
 (268 stars)
PR merge metrics
 (PR metrics pending)

Description

Overlay schemas could be a very powerful tool for consumers to validate custom policies for their types. We should document how to use them for CRDs and native types

Contributor guide

Research direction
Review existing documentation in the repo, identify where overlay schemas are currently described, and add a new section explaining how users can define custom validation policies for CRDs and native types using overlay schemas.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Kubernetes CRD basicsUnderstanding of schema validation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70