Skip to content

Latest commit

 

History

History
98 lines (55 loc) · 5.24 KB

README.md

File metadata and controls

98 lines (55 loc) · 5.24 KB
Raw

The Kyverno Website

Source for: https://kyverno.io

Contributors

Made with contributors-img.

Contributing

This site makes use of the Docsy theme and Hugo Extended is required to render it.

To contribute changes, use the fork & pull approach.

1. First create a fork of the Kyverno website repository to your GitHub account. By default, the forked repository will be named website but can be changed in the settings for your repository if desired. You will later created a PR (pull request) using this fork.

2. Next, create a local clone with the --recurse-submodules option:

git clone https://github.com/{YOUR-GITHUB-ID}/website kyverno-website/ --recurse-submodules

3. Then navigate to the local folder and build the website for local viewing of changes:

cd kyverno-website
hugo server -v

By default, Hugo runs the website at: http://localhost:1313 and will re-build the site on changes.

Rendering Policies to Markdown

Policies found at https://kyverno.io/policies/ are generated in Markdown from the source repository at kyverno/policies. For any changes to appear on https://kyverno.io/policies/, edits must be made to the upstream policy YAML files at kyverno/policies, and the render tool run from this repository to generate the respective Markdown. See render README for more details.

Style and typographical conventions

The Kyverno website has established several writing conventions in the interest of consistency and accuracy.

Voice

Active voice is preferred in most writing examples. Ex., "this ClusterPolicy mutates incoming Pods..." and not "incoming Pods are mutated by this ClusterPolicy".

Code styling

  • Kubernetes resource kinds are considered proper nouns and are distinguished from other nouns by the initial letter capitalization. Ex., "a Kubernetes Pod will be annotated".
  • Anything intended to be proper code or typed at a CLI is formatting using Markdown code syntax with backticks or in blocks (surrounded by three backticks).
  • Code represented in blocks should prefer a syntax declaration for this theme's highlighting ability. Ex., when displaying YAML notate the code block with three backticks and "yaml".

Grammar

  • We standardize on use of the Oxford comma.

Documentation Versioning

The Kyverno website now uses releases to organize documentation by the specified release making it easier for users to find the information that pertains to their version. Releases are defined by branches of kyverno/website and a combination of exposing them in the website configuration and modifying hosting parameters.

Managing Release Versions

Here are the rules for managing release versions:

  1. All fixes and feature changes go to the main branch (we may in a few rare cases make fixes to prior versions of the documentation.) The main branch can be accessed at https://main.kyverno.io.

  2. When a new release is ready for GA, a new release branch is created (see steps below). Release branches are named release-{major}-{minor}-{patch} for example release-1-4-2. The release branch can be accessed using the {branch}.kyverno.io and the latest release is available at kyverno.io.

Creating a release branch

To create a new release branch:

  1. Create and push the branch using git checkout -b release-{major}-{minor}-{patch} or via GitHub.

  2. Update Netlify to point production to the new release.

In the main branch:

  1. Update the versions list in config.toml to add the next release.

  2. Update version_menu and version in params.toml for the next release.

  3. Create a PR.

Submitting a PR to multiple release branches

Ideally all changes will go to main and then be promoted to a release branch. However, occasionally we will need to fix documentation issues for already released versions. For such cases, a PR must be created for each release branch. Rendered policies will always go to all branches because the policy samples themselves declare minimum capable versions via the policies.kyverno.io/minversion annotation.

There are several ways to create multiple PRs, but here is one easy flow:

  1. Create a PR for the main branch, as usual.
  2. For each additional branch, checkout the branch (git checkout <branch>), and then cherry pick the commit(s) to that branch using git --cherry-pick <commit>. If using GitHub Desktop, a commit can be cherry picked by setting the source branch where the PR was merged, accessing the History tab, and dragging-and-dropping that commit to the destination branch.
  3. Submit PRs for each release branch.

Customize other settings

Edit the .toml files inside the config/_default directory.