docs: refresh Getting Started, Home, and Image Installation guides#1001
docs: refresh Getting Started, Home, and Image Installation guides#1001rachael-george wants to merge 2 commits into
Conversation
Signed-off-by: rachael-george <rgeorge@redhat.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly updates the documentation for AutoHCK, including manual installation steps, configuration guides (focusing on override.json), CLI references, and image installation instructions. The review feedback highlights a few issues in the updated documentation: a potential Ruby version mismatch on RHEL 9, an incorrect path for the swtpm_setup binary in a validation command, a missing closing brace in a JSON example, and the need to mention install.esd as an alternative to install.wim for certain Windows ISOs.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| sudo dnf install -y slirp4netns net-tools ethtool xorriso jq swtpm swtpm-tools | ||
| slirp4netns --version | ||
| which ifconfig ethtool xorriso jq | ||
| test -x /usr/bin/swtpm_setup && echo "swtpm OK" |
There was a problem hiding this comment.
On Fedora and RHEL, the swtpm_setup binary is installed to /usr/sbin/swtpm_setup (by the swtpm-tools package) rather than /usr/bin/swtpm_setup. Using test -x /usr/bin/swtpm_setup will fail to validate the installation. It is recommended to check /usr/sbin/swtpm_setup instead.
| test -x /usr/bin/swtpm_setup && echo "swtpm OK" | |
| test -x /usr/sbin/swtpm_setup && echo "swtpm OK" |
There was a problem hiding this comment.
Changed to command -v instead, to be path agnostic
| -> "result_uploaders": [ "dropbox" ] | ||
| } | ||
|
|
There was a problem hiding this comment.
The closing brace } for the JSON snippet was accidentally removed, making the example syntactically incomplete. Let's restore it.
| -> "result_uploaders": [ "dropbox" ] | |
| } | |
| -> "result_uploaders": [ "dropbox" ] | |
| } |
Signed-off-by: rachael-george <rgeorge@redhat.com>
|
|
||
| - `qemu_bin` — QEMU system emulator. | ||
| - `qemu_img_bin` — `qemu-img` for disk image operations. | ||
| - `ivshmem_server_bin` — `ivshmem-server` when using a source QEMU build; leave `""` for distro packages. |
There was a problem hiding this comment.
This is mandatory only for Ivshmem driver testing. Any ivshmem-server binary can be used
| - `qemu_bin` — QEMU system emulator. | ||
| - `qemu_img_bin` — `qemu-img` for disk image operations. | ||
| - `ivshmem_server_bin` — `ivshmem-server` when using a source QEMU build; leave `""` for distro packages. | ||
| - `fs_daemon_bin` — `virtiofsd` host file-sharing daemon. |
There was a problem hiding this comment.
This is mandatory only for virtiofs driver testing. leave "" if you don't have virtiofsd and don't want to test virtiofs driver
| ## Microsoft HLK playlists | ||
|
|
||
| To run HLK tests with the latest Microsoft compatibility playlist clone [HLK Playlists](https://github.com/HCK-CI/hlkplaylists) inside AutoHCK and rename the directory to playlists, once it's there AutoHCK will look for the right XML playlist file and apply it to the tests. | ||
| If you followed [step 5](#manual-installation), `playlists/` is already in place. Otherwise clone [HLK Playlists](https://github.com/HCK-CI/hlkplaylists) to `playlists/` at the AutoHCK repo root (path configured in `hcktest.json` → `playlists_path`). AutoHCK selects the appropriate XML playlist for the kit/platform. |
There was a problem hiding this comment.
|
Please squash commits and force-push this PR |
2 participants
Refresh the core setup and usage docs with step-by-step manual installation guidance, a structured override.json workflow, and corrected configuration references (kits/.json, qemu_machine.json paths).
Getting Started — Adds an overview workflow, Fedora/RHEL prerequisite commands, dependency layout (filters/, playlists/, sibling repos), and a detailed override.json guide with validation commands; updates Ruby requirement to ≥ 3.3.0.
Home — Syncs the CLI reference with current bin/auto_hck options, documents triggers_check for selective CI, fixes workspace path layout, and updates examples to real platform names.
Image Installation — Expands ISO/kit configuration guidance, fixes kit file paths, improves UEFI ISO patching examples, and corrects the install platform example (Win10_2004x86_bios).