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 Hugo. It uses Google's Docsy theme and is built and hosted on Netlify. The contents of the website are written as standard Markdown files allowing easy editing and contribution.
This repository contains a custom Codespaces devcontainer which allows you to quickly get started with contributing through a containerized environment with all the tools necessary, all of which runs inside GitHub. Creation of a Codespace on this repository will result in a fully-provisioned containerized environment with the repository contents and Hugo extended.
If you are new to Codespaces and devcontainers, please see the introductory guide here.
The Kyverno website requires the Hugo extended version be installed. When developing locally and not in the provided GitHub devcontainer, you must ensure you have the extended version of Hugo and not the standard version. Additionally, this website currently requires a Hugo version of v0.100 or greater.
To check and ensure you are using a compatible version of Hugo, both the version number and the extended edition, the output of the hugo version command should look something like below.
$ hugo version
hugo v0.119.0-b84644c008e0dc2c4b67bd69cccf87a41a03937e+extended darwin/amd64 BuildDate=2023-09-24T15:20:17Z VendorInfo=brewOnce you have made your changes, inspect them visually by rendering the website.
hugo serverNote
On Windows, when running the hugo server command, make sure to execute it with administrator privileges in your terminal. This is necessary to ensure proper access and functionality during the server execution.
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.