Expand Test Kitchen driver docs and improve SEO (CHEF-37533) - #4716
Draft
Kuxhul wants to merge 2 commits into
Draft
Expand Test Kitchen driver docs and improve SEO (CHEF-37533)#4716Kuxhul wants to merge 2 commits into
Kuxhul wants to merge 2 commits into
Conversation
Update the Test Kitchen driver documentation to list all supported drivers, using the Kitchen CI drivers page as a reference. Add the kitchen-docker, kitchen-habitat, kitchen-opennebula, kitchen-vcair, kitchen-vcenter, kitchen-vra, and kitchen-vro drivers, add guidance on verifying that a driver gem is installed in the active Ruby environment, and link to the upstream drivers reference. Add description and summary front matter to the Test Kitchen tool pages across workstation 25, 26.0, and 26.1 to improve search discoverability of the official Progress Chef documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
✅ Deploy Preview for chef-web-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Restructure the Test Kitchen driver documentation so drivers are no longer buried inside the kitchen.yml page. Add a Drivers dropdown under Test Kitchen in the workstation 25, 26.0, and 26.1 menus, with a drivers landing page and a dedicated page for each core driver: azurerm, digitalocean, dokken, ec2, google, hyperv, openstack, vagrant, vcenter, and vra. Each driver page follows the kitchen-vagrant page format with an overview, an example kitchen.yml, and a link to the driver repository. Move the kitchen-vagrant page under the Drivers dropdown and add an alias from its previous URL. List additional drivers (cloudstack, docker, dsc, habitat, opennebula, rackspace, vcair, and vro) on the drivers landing page with links to their repositories. Replace the inline driver list in the kitchen.yml page with a pointer to the new Drivers section. Add a note on each driver page to verify configuration options against the version of the driver installed in the Test Kitchen environment, because the upstream driver documentation can lag behind the code. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Addresses CHEF-37533 and incorporates review feedback to give Test Kitchen drivers a dedicated, discoverable home instead of burying them inside the
kitchen.ymlpage.New Drivers section
config/_default/menu.toml).tools/kitchen/drivers/) that lists every supported driver.kitchen-vagrantpage (overview → examplekitchen.yml→ link to the driver repository):azurerm,digitalocean,dokken,ec2,google,hyperv,openstack,vagrant,vcenter,vra.aliasfrom its previous URL so existing links keep working.cloudstack,docker,dsc,habitat,opennebula,rackspace,vcair,vro) on the landing page with links to their repositories.kitchen.ymlpage with a pointer to the new Drivers section.Accuracy note
Each driver page includes a note to verify configuration options against the installed driver version, since the upstream Kitchen CI docs can lag behind the code. Config parameters still need a final check with engineering against the latest Test Kitchen Enterprise.
SEO
Retains the
description/summaryfront matter added earlier and extends it to the new driver pages.Validation
markdownlint-cli2passes on all changed and new files.menu.toml) and all page front matter validated as well-formed TOML; Hugo loads the config and assembles the menu without errors. Full render is validated by the Netlify deploy preview.Notes
Kept as a draft for review. Reference format based on the
kitchen-vagrantpage and the Kitchen CI driver pages (reworded, not copied).