{"id":18684548,"url":"https://github.com/kubevirt/user-guide","last_synced_at":"2025-10-25T03:03:32.060Z","repository":{"id":37502902,"uuid":"102581812","full_name":"kubevirt/user-guide","owner":"kubevirt","description":"This user guide will walk you through installation and various features.","archived":false,"fork":false,"pushed_at":"2025-03-24T14:15:35.000Z","size":35715,"stargazers_count":67,"open_issues_count":16,"forks_count":243,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-01T11:04:29.614Z","etag":null,"topics":["documentation","hacktoberfest","kubernetes","virtualization"],"latest_commit_sha":null,"homepage":"https://kubevirt.io/user-guide","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubevirt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-06T08:13:03.000Z","updated_at":"2025-03-29T10:24:55.000Z","dependencies_parsed_at":"2023-02-18T17:00:34.322Z","dependency_job_id":"b9ef7b72-6b57-44f6-ab26-f7b946d80900","html_url":"https://github.com/kubevirt/user-guide","commit_stats":{"total_commits":1044,"total_committers":167,"mean_commits":6.251497005988024,"dds":0.7825670498084292,"last_synced_commit":"e89accc2f9d65a2056436b80d9dd360a7c11148b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubevirt%2Fuser-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubevirt%2Fuser-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubevirt%2Fuser-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubevirt%2Fuser-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubevirt","download_url":"https://codeload.github.com/kubevirt/user-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247838445,"owners_count":21004580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","kubernetes","virtualization"],"created_at":"2024-11-07T10:18:02.010Z","updated_at":"2025-10-25T03:03:31.967Z","avatar_url":"https://github.com/kubevirt.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KubeVirt User-Guide\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/2430a4f6-4a28-4e60-853d-f0cc395e13bb/deploy-status)](https://app.netlify.com/sites/kubevirt-user-guide/deploys)\n\n## Contributing contents\n\nWe more than welcome contributions to KubeVirt documentation. Please reach out if you happen to have an idea or find an issue with our contents!\n\n## Get started\n\n### Fork this repository\n\n### Make changes to your fork\n\nYou can find the markdown that powers the user guide in `./docs`, most commits are to that area.\n\nWe use [mkdocs](https://www.mkdocs.org/) markdown engine with [mkdocs-awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) plugin\n  - mkdocs config file\n  - Each subdirectory of `./docs` contains a `.pages` file.  We use this to force the ordering of pages.  Alphabetical ordering is not ideal for technical documentation.\n\n#### Sign your commits\n\nSignature verification on commits are required -- you may sign your commits by running:\n\n```console\n$ git commit -s -m \"The commit message\" file1 file 2 ...\n```\n\nIf you need to sign all commits from a certain point (for example, `main`), you may run:\n\n```console\ngit rebase --exec 'git commit --amend --no-edit -n -s' -i main\n```\n\nSigned commit messages generally take the following form:\n\n```\n\u003cyour commit message\u003e\n\nSigned-off-by: \u003cyour configured git identity\u003e\n```\n\n\n### Test your changes locally:\n\n```console\n$ make build_img\n$ make check_spelling\n$ make check_links\n$ make run\n```\n\n**NOTE** If you use `docker` you may need to set `CONTAINER_ENGINE` and `BUILD_ENGINE`:\n\n```console\n$ export CONTAINER_ENGINE=docker\n$ export BUILD_ENGINE=docker\n$ make run\n```\n\n\u003c!-- markdown-link-check-disable --\u003e\nOpen your web browser to http://0.0.0.0:8000 and validate page rendering\n\u003c!-- markdown-link-check-enable --\u003e\n\n### Create a pull request to `kubevirt/user-guide`\n\nAfter you have vetted your changes, make a PR to `kubevirt/user-guide` so that others can review.\n\n## Makefile Help\n\n```console\nMakefile for user-guide mkdocs application\n\nUsage:\n  make \u003ctarget\u003e\n\nEnv Variables:\n  CONTAINER_ENGINE      Set container engine, [*podman*, docker]\n  BUILD_ENGINE          Set build engine, [*podman*, buildah, docker]\n  SELINUX_ENABLED       Enable SELinux on containers, [*False*, True]\n  LOCAL_SERVER_PORT     Port on which the local mkdocs server will run, [*8000*]\n\nTargets:\n  help                   Show help\n  check_links            Check external and internal links\n  check_spelling         Check spelling on site content\n  build_img  Build image: userguide\n  build_image_yaspeller  Build image: yaspeller\n  build                  Build site. This target should only be used by Prow jobs.\n  run                    Run site.  App available @ http://0.0.0.0:8000\n  status                 Container status\n  stop                   Stop site\n  stop_yaspeller         Stop yaspeller image\n```\n\n### Environment Variables\n\n* `CONTAINER_ENGINE`: Some of us use `docker`. Some of us use `podman` (default: `podman`).\n\n* `BUILD_ENGINE`: Some of us use `docker`. Some of us use `podman` or `buildah` (default: `podman`).\n\n* `SELINUX_ENABLED`: Some of us run SELinux enabled. Set to `True` to enable container mount labelling.\n\n* `PYTHON`: Change the `python` executable used (default: `python3.7`).\n\n* `PIP`: Change the `pip` executable used (default: `pip3`).\n\n* `LOCAL_SERVER_PORT`: Port on which the local `mkdocs` server will run, i.e. `http://localhost:\u003cport\u003e` (default: `8000`).\n\n* `DEBUG`: This is normally hidden. Set to `True` to echo target commands to terminal.\n\n### Targets:\n\n* check_links: HTMLProofer is used to check any links to external websites as we as any cross-page links\n\n* check_spelling: yaspeller is used to check spelling.  Feel free to update to the dictionary file as needed (`kubevirt/project-infra/images/yaspeller/.yaspeller.json`).\n\n* build_img: mkdocs project does not provide a container image.  Use this target to build an image packed with python and mkdocs app.  ./docs will be mounted.  ./site will be mounted as tmpfs...changes here are lost.\n\n* build_image_yaspeller: yaspeller project does not provide a container image.  User this target to Build an image packed with nodejs and yaspeller app.  ./docs will be mounted.  yaspeller will check content for spelling and other bad forms of English.\n\n* status: Basically `${BUILD_ENGINE} ps` for an easy way to see what's running.\n\n* stop: Stop container and app\n\n* stop_yaspeller: Sometimes yaspeller goes bonkers.  Stop it here.\n\n## Getting help\n\n- File a bug: \u003chttps://github.com/kubevirt/user-guide/issues\u003e\n\n- Mailing list: \u003chttps://groups.google.com/forum/#!forum/kubevirt-dev\u003e\n\n- Slack: \u003chttps://kubernetes.slack.com/messages/virtualization\u003e\n\n## Developer\n\n- Start contributing: \u003chttps://kubevirt.io/user-guide/contributing\u003e\n\n## Privacy\n\n- Check our privacy policy at: \u003chttps://kubevirt.io/privacy/\u003e\n\n- We do use \u003chttps://netlify.com\u003e Open Source Plan for rendering Pull Requests to the documentation repository\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubevirt%2Fuser-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubevirt%2Fuser-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubevirt%2Fuser-guide/lists"}