Docs: rewrite README for new users and split contributor docs - #161
Merged
Merged
Conversation
The README pointed at kitchen.ci for all configuration and documented no options itself. Rewrite it around a new user's path: requirements, installation, a working quick start, an explanation of the differencing disk model, then a full reference for every driver option read from the source. All 29 default_config/required_config keys are now documented, grouped by concern, along with copy_vm_files and dry_run, which are read from config but never declared via default_config and so were previously undocumented. Adds examples for generation 2 guests, dynamic memory, static networking, additional disks, file copy, and remote Hyper-V hosts. Examples default to Cinc Workstation and cinc_infra, with a "Using with Chef" section covering the Chef Workstation equivalents. Move the Contributing section into a new CONTRIBUTING.md covering setup, the rake test/quality tasks, manual testing on a real Hyper-V host, and the release process. Also drops the Azure Pipelines badge, which pointed at a master branch build definition that no longer runs. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Tim Smith <tsmith84@proton.me>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rewrites
README.mdaround a new user's path and moves contributor-only material into a newCONTRIBUTING.md.Why
The old README was 44 lines and delegated all configuration to kitchen.ci, so there was no way to discover what the driver accepts without reading the source.
README
kitchen.ymlAll 29
default_config/required_configkeys are documented. So arecopy_vm_filesanddry_run, which are read fromconfigbut never declared viadefault_configand were previously undocumented anywhere.Also removes the Azure Pipelines badge, which points at a
masterbranch build definition that no longer runs.CONTRIBUTING.md
New file, absorbing the README's Contributing section: issue reporting (including the
dry_runtip), dev setup, the actualrake test/rake qualitytask names from the Rakefile, a note that the unit tests stub PowerShell so they run anywhere, guidance on manual testing against a real Hyper-V host, and the release process.Docs only — no code changes.