The kubevirt/user-guide repository serves as the official documentation resource for KubeVirt, a Kubernetes-native virtualization platform. The repository is built primarily using Makefile as its primary language and hosts markdown-based documentation that guides users through installation procedures and various KubeVirt features. The documentation is powered by mkdocs, a markdown documentation engine, combined with the mkdocs-awesome-nav plugin to enable custom page ordering rather than alphabetical sorting, which is more suitable for technical documentation.
The repository's documentation content is organized within the ./docs directory, where each subdirectory contains a .nav.yml file to control page ordering and structure. Contributors are encouraged to make changes to the markdown files in this directory, and the project maintains a welcoming stance toward documentation contributions. The build system is containerized, supporting both Docker and Podman as container engines, with configurable environment variables for CONTAINER_ENGINE, BUILD_ENGINE, PYTHON, and PIP executables. The local development workflow allows contributors to test changes by running a local mkdocs server on a configurable port before submitting pull requests.
The repository implements several quality assurance mechanisms through its Makefile targets. The check_links target uses HTMLProofer to validate both external website links and cross-page references. The check_spelling target employs yaspeller to verify spelling and English language correctness. The build_img target constructs a container image with Python and mkdocs, while build_image_yaspeller creates a separate image for spelling checks. Additional targets include status for monitoring running containers and stop commands for halting services.
GitGenius activity data reveals that the repository maintains a median issue and pull request response latency of 43.8 hours across 33 tracked items, though the mean extends to 1019.3 hours, indicating some longer-running discussions. The most frequently applied issue labels are lifecycle/rotten with 20 occurrences, good-first-issue with 14, and kind/bug with 8, suggesting the project actively manages issue lifecycle and encourages new contributors. The most active contributor tracked is aburdenthehand with 53 events, followed by 0xFelix and anishbista60 with 5 events each. The repository shares contributors with kubevirt/kubevirt, kubernetes/minikube, and metallb/metallb, indicating cross-project collaboration within the Kubernetes ecosystem.
The project requires signed commits for all contributions, enforcing cryptographic verification of commit authenticity. The repository is classified across multiple domains including user guide, VM deployment, orchestration, infrastructure as code, containerized workloads, VM management, disaster recovery, virtualization, and cloud-native infrastructure. Support channels include GitHub issues, a Google Groups mailing list for kubevirt-dev, and a Kubernetes Slack channel dedicated to virtualization. The documentation is rendered through Netlify's Open Source Plan, which automatically generates preview builds for pull requests.
