search

kubevirt / user-guide

This user guide will walk you through installation and various features.
https://kubevirt.io/user-guide
Apache License 2.0
64 stars 233 forks source link

kubevirt #11083 fix: broken formatting (and some editing) #763

Closed aburdenthehand closed 8 months ago

aburdenthehand commented 9 months ago

What this PR does / why we need it: Issue #11083 in the kubevirt/kubevirt raised some broken formatting, making the examples difficult to understand.

While fixing these, I reformatted some of the titles which weren't so optimal with the new ToC. I also did some unrequested editing that started with removing some double spaces and ended with some rewrites and adding some additional context to the examples. Finally, I've added yaml tags to the blocks and added slightly more context to the KubeVirt CR snippets used so that they are easier to differentiate from the lists of device types.

Direct link to build: https://deploy-preview-763--kubevirt-user-guide.netlify.app/operations/mediated_devices_configuration/

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged): Fixes #11083 in the kubevirt/kubevirt

Special notes for your reviewer:

@vladikr - my apologies for making this a bigger change than initially suggested.

Release note:

NONE
vladikr commented 9 months ago

@aburdenthehand, I think this is great! /approve

kubevirt-bot commented 9 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vladikr

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubevirt/user-guide/blob/main/OWNERS)~~ [vladikr] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
victortoso commented 8 months ago

A nice improvement! /lgtm