kubevirt/user-guide

KubeVirt User-Guide is a documentation repository that provides installation instructions and feature walkthroughs for KubeVirt, a Kubernetes-native virtualization platform.

The guide addresses the need for comprehensive documentation on deploying and managing virtual machines within Kubernetes clusters. It uses mkdocs with the mkdocs-awesome-nav plugin to organize markdown content stored in the docs directory, with each subdirectory containing a .nav.yml file to control page ordering rather than relying on alphabetical sorting. The documentation is built and served through containerized environments supporting both Docker and Podman, with local testing available via a development server.

Contributors should know that this is a documentation project welcoming community input on content improvements and corrections. The repository uses signed commits as a requirement and provides Makefile targets for common tasks including link checking via HTMLProofer, spell checking via yaspeller, and local preview rendering. Those adopting this guide should expect to find detailed information on KubeVirt deployment and feature usage, with the ability to build and test documentation changes locally before submission.

The project experiences slow response times on issues and pull requests, often waiting weeks for initial feedback. Work in the issue tracker centers on bug reports, good-first-issue items, and hacktoberfest contributions.