openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

Virtualization docs fixes during ROSA review 2

Open mburke5678 opened this issue 1 year ago • 4 comments

Fixing various errors in the Applications docs as I find them during the ROSA content port. Mostly formatting, wording, and such.

Previews: Creating backup hooks -- Removed stray [] from code example. Installing the Data Protection Application 1.2 and earlier -- Changed the verification header type. Installing the Data Protection Application 1.3 -- Changed the verification header type. Enabling self-signed CA certificates -- Changed ... to # ... Setting Velero CPU and memory resource allocations -- Changed ... to # ... Adding a key when creating a VM from a template -- Changed single step Verification to a bullet Adding a key when creating a VM by using the command line -- Changed single step Verification to a bullet Enabling dynamic key injection when creating a VM from a template -- Changed single step Verification to a bullet Enabling dynamic key injection by using the command line -- Changed single step Verification to a bullet Creating a snapshot by using the command line -- s/v1alpha1/v1alpha1 [ ] QE has approved this change. Defining a guest agent ping probe -- Added code example metadata and fixed YAML spacing. Defining an HTTP liveness probe -- Added code example metadata and fixed YAML spacing. Defining an HTTP readiness probe -- Added code example metadata and fixed YAML spacing. Defining a TCP readiness probe -- Added code example metadata and fixed YAML spacing. PXE booting with a specified MAC address -- Fix formatting in Step 4. Current docs Restoring a VM from a snapshot by using the command line -- s/v1alpha1/v1alpha1 [ ] QE has approved this change. CDIStorageProfilesIncomplete -> Mitigation -- Switched specific object name in code example to generic, in order to match the previous command. Generating a temporary token for the VNC console -- Removed a stray # ... from a command example. Verifying online snapshots by using snapshot indications -- Changed sub-bullets in step 1. It doesn't matter how the snapshots were created. Current docs.
Scheduling virtual machines with a custom scheduler -- Changed formatting to Verification to avoid an odd a numbered substep under a bullet. Current docs.

mburke5678 avatar Dec 21 '23 22:12 mburke5678

🤖 Wed Apr 10 13:24:40 - Prow CI generated the docs preview:

https://69687--ocpdocs-pr.netlify.app/ https://69687--ocpdocs-pr.netlify.app/openshift-dedicated/latest/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.html https://69687--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.html https://69687--ocpdocs-pr.netlify.app/openshift-rosa/latest/virt/virtual_machines/advanced_vm_management/virt-schedule-vms.html

ocpdocs-previewbot avatar Dec 21 '23 22:12 ocpdocs-previewbot

The branch/enterprise-4.16 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.15. And any PR going into main must also target the latest version branch (enterprise-4.16).

If the update in your PR does NOT apply to version 4.16 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

kalexand-rh avatar Feb 26 '24 20:02 kalexand-rh

@kbidarkar As part of the project to port docs content from OCP to ROSA/OSD, I performed each of the procedures in the Virtualization book. I found various places where there were changes, mistakes, etc. There are a few changes that I would feel more comfortable if QE reviewed the changes, all are indicated with QE REVIEW NEEDED. Pan suggested this is something you could help with. Please let me know if you can help. There is no hard deadline; but, I would like to merge these PRs, as they have been lingering for awhile.

mburke5678 avatar Mar 25 '24 17:03 mburke5678

@jpeimer Thank you for all your help! There are still a couple of changes I am hoping to get confirmed. You tagged @sradco in one. I would love to get this PR closed!

mburke5678 avatar Mar 28 '24 21:03 mburke5678

@jpeimer Do you have any further comments, in particular on the Storage portion, as suggested by @kbidarkar?

mburke5678 avatar Apr 04 '24 16:04 mburke5678

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-ci[bot] avatar Apr 10 '24 13:04 openshift-ci[bot]

/cherrypick enterprise-4.14

mburke5678 avatar Apr 10 '24 20:04 mburke5678

/cherrypick enterprise-4.15

mburke5678 avatar Apr 10 '24 20:04 mburke5678

/cherrypick enterprise-4.16

mburke5678 avatar Apr 10 '24 20:04 mburke5678

@mburke5678: new pull request created: #74499

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mburke5678: new pull request created: #74500

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mburke5678: new pull request created: #74501

In response to this:

/cherrypick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.