Thank you for expressing interest in contributing to the Kyverno documentation! We welcome all contributions, suggestions, and feedback! We'd love to accept your contributions to this project, there are just a few guidelines you need to follow.
Contributions to this project must be accompanied by a Contributor License Agreement. Project authors will retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
This project follows the CNCF Code of Conduct.
If you wish to contribute to this project, there are several options as outlined below.
Report Issues Submit a Pull Request Join Our Community Meetings
If you see a bug or want to suggest an enhancement, please create an issue. Issues are a great way to tell the Kyverno documentation team what you think can be improved or fixed. Even reporting a misspelling is appreciated!
Find an open issue and indicate your interest by requesting assignment. We understand that sometimes priorities change, so if you've been assigned an issue but are no longer able to or interested in completing it, please unassign yourself so future contributors know it is available to take on.
If you are new to the git contribution flow or GitHub in general, please see the excellent documentation available on the Git website with easy, step-by-step instructions on how to create your first Pull Request on GitHub.
The Kyverno website is a static site designed and built using Astro. It uses the Starlight documentation theme and is built and hosted on Netlify. The contents of the website are written as standard Markdown and MDX files allowing easy editing and contribution. For more detailed development information, see DEVELOPMENT.md.
This repository can be developed using GitHub Codespaces, which provides a containerized development environment with all the necessary tools. If a devcontainer configuration is available, creating a Codespace will automatically set up the environment with Node.js and npm.
If you are new to Codespaces and devcontainers, please see the introductory guide here.
The Kyverno website requires Node.js v24 or higher and npm to be installed. When developing locally, ensure you have the correct Node.js version installed.
To check your Node.js version:
$ node --version
v24.11.1You should see v24 or higher. If you need to install or update Node.js, visit nodejs.org.
After cloning the repository, install dependencies:
npm installFor more detailed setup instructions, see DEVELOPMENT.md.
Once you have made your changes, inspect them visually by rendering the website.
npm run devThe development server will start at http://localhost:4321. The site will automatically reload when you make changes to source files.
For more information about testing and building, see DEVELOPMENT.md.
Kyverno maintains a thriving community with two different opportunities to participate. The largest is the Kubernetes Slack workspace and the other is the CNCF Slack workspace.
For the available Kyverno meetings, see here.
For contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project, we require everyone to acknowledge this by signing their work acknowledging the DCO.
For a complete guide on DCO, please see this article.
For users of Visual Studio Code, there is a convenient setting in the git extension named "Always Sign Off" which, when checked, allows VS Code to sign all commits.