MTV-5019: Preparing the MTV repo for AEM/DITA migration #897
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
c1fe6d8 to
d08a486
Compare
8766d89 to
6a8c45c
Compare
6a8c45c to
8b49c15
Compare
8b49c15 to
2208567
Compare
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughDocumentation refinements across the Migration Toolkit for Virtualization (MTV) guide: standardize VMware branding with the ChangesDocumentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@documentation/modules/about-rego-files.adoc`:
- Line 12: Replace the pseudo-hash `{“category”, “label”, “assessment”}` with
clear object/key wording in the sentence that describes what each `.rego` rule
adds to `concerns`: say that the rule "adds an object with `category`, `label`,
and `assessment` keys to the `concerns` array/key in the VM inventory record"
and keep the rest of the sentence about the web console and `<provider>`
inventory unchanged; update the paragraph in the documentation module
`about-rego-files.adoc` accordingly.
In `@documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc`:
- Line 12: Replace the hardcoded vendor name in the sentence "VDDK is mandatory
for migrations from VMware vSAN storage." by using the document attribute {vmw};
update the string to "VDDK is mandatory for migrations from {vmw} vSAN storage."
so the module consistently uses the {vmw} attribute (locate the sentence
containing "VDDK is mandatory for migrations from VMware vSAN storage.").
In `@documentation/modules/rn-2-11-0-resolved-issues.adoc`:
- Line 28: Replace the inconsistent link label
"link:https://issues.redhat.com/browse/MTV-3476[(MTV-3476)]" so it matches the
rest of the module's format by removing the parentheses around the ticket label,
i.e. change the trailing "[(MTV-3476)]" to "[MTV-3476]" so the link uses the
same bracketed label style as other entries.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ad0a0997-05fe-49ff-977b-642a4aba2669
📒 Files selected for processing (14)
documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adocdocumentation/modules/about-cold-warm-migration.adocdocumentation/modules/about-mtv.adocdocumentation/modules/about-rego-files.adocdocumentation/modules/common-attributes.adocdocumentation/modules/con_migrating-vms-by-using-mtv-ui.adocdocumentation/modules/migration-plan-options-ui.adocdocumentation/modules/new-features-and-enhancements-2-11.adocdocumentation/modules/proc_adding-source-provider.adocdocumentation/modules/proc_storage-copy-offload-cli.adocdocumentation/modules/proc_storage-copy-offload-ui.adocdocumentation/modules/proc_troubleshooting-vddk-required-vsan.adocdocumentation/modules/rn-2-11-0-resolved-issues.adocdocumentation/modules/running-migration-plan.adoc
There was a problem hiding this comment.
♻️ Duplicate comments (1)
documentation/modules/about-rego-files.adoc (1)
12-12:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winReplace pseudo-hash notation with clear object/key wording
Line 12 still uses
{"category", "label", "assessment"}, which is not valid object notation and can confuse readers. Please reword this as an object withcategory,label, andassessmentkeys added toconcerns.Suggested fix
-Each validation rule is defined in a separate `.rego` file and tests for a specific condition. If the condition evaluates as `true`, the rule adds a `{"category", "label", "assessment"}` hash to the `concerns`. The `concerns` content is added to the `concerns` key in the inventory record of the virtual machine (VM). The web console displays the content of the `concerns` key for each VM in the `_<provider>_` inventory. +Each validation rule is defined in a separate `.rego` file and tests for a specific condition. If the condition evaluates as `true`, the rule adds an object with `category`, `label`, and `assessment` keys to `concerns`. The `concerns` content is added to the `concerns` key in the inventory record of the virtual machine (VM). The web console displays the content of the `concerns` key for each VM in the `_<provider>_` inventory.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@documentation/modules/about-rego-files.adoc` at line 12, The sentence uses invalid pseudo-hash notation {"category", "label", "assessment"}; update the wording in the about-rego-files.adoc paragraph so it clearly describes adding an object with keys category, label and assessment to the concerns (e.g., state that a rule appends an object containing the category, label and assessment keys to the concerns list), and keep the rest of the sentence about concerns being stored in the concerns key of the VM inventory and displayed in the _<provider>_ inventory unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@documentation/modules/about-rego-files.adoc`:
- Line 12: The sentence uses invalid pseudo-hash notation {"category", "label",
"assessment"}; update the wording in the about-rego-files.adoc paragraph so it
clearly describes adding an object with keys category, label and assessment to
the concerns (e.g., state that a rule appends an object containing the category,
label and assessment keys to the concerns list), and keep the rest of the
sentence about concerns being stored in the concerns key of the VM inventory and
displayed in the _<provider>_ inventory unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ee912c50-9d03-4bb8-b484-f38e30269de9
📒 Files selected for processing (3)
documentation/modules/about-rego-files.adocdocumentation/modules/proc_troubleshooting-vddk-required-vsan.adocdocumentation/modules/running-migration-plan.adoc
91079bd to
8666382
Compare
8666382 to
77da7d5
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@documentation/modules/about-mtv.adoc`:
- Line 25: Update the sentence that begins "Live migration is available *_only_*
for migrations between {virt} clusters..." to mark live migration as a
Technology Preview feature: add a clear disclaimer after the feature statement
indicating it is Technology Preview (not covered by Red Hat production SLAs and
not recommended for production use) and preserve the version requirements
({project-short} 2.10+, {virt} 4.20+); ensure the wording mentions "Technology
Preview" explicitly and that it is unsupported for production.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: edbab79a-cac4-4dae-9d33-8aa84c3b62a4
📒 Files selected for processing (14)
documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adocdocumentation/modules/about-cold-warm-migration.adocdocumentation/modules/about-mtv.adocdocumentation/modules/about-rego-files.adocdocumentation/modules/common-attributes.adocdocumentation/modules/con_migrating-vms-by-using-mtv-ui.adocdocumentation/modules/con_planning-intro.adocdocumentation/modules/migration-plan-options-ui.adocdocumentation/modules/new-features-and-enhancements-2-11.adocdocumentation/modules/proc_adding-source-provider.adocdocumentation/modules/proc_storage-copy-offload-cli.adocdocumentation/modules/proc_storage-copy-offload-ui.adocdocumentation/modules/proc_troubleshooting-vddk-required-vsan.adocdocumentation/modules/running-migration-plan.adoc
✅ Files skipped from review due to trivial changes (11)
- documentation/modules/proc_adding-source-provider.adoc
- documentation/modules/common-attributes.adoc
- documentation/doc-Planning_your_migration/assemblies/assembly_migrating-vms-web-console.adoc
- documentation/modules/con_migrating-vms-by-using-mtv-ui.adoc
- documentation/modules/migration-plan-options-ui.adoc
- documentation/modules/about-cold-warm-migration.adoc
- documentation/modules/proc_troubleshooting-vddk-required-vsan.adoc
- documentation/modules/new-features-and-enhancements-2-11.adoc
- documentation/modules/proc_storage-copy-offload-ui.adoc
- documentation/modules/con_planning-intro.adoc
- documentation/modules/proc_storage-copy-offload-cli.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
- documentation/modules/about-rego-files.adoc
- documentation/modules/running-migration-plan.adoc
a365847 to
3354bc2
Compare
ede8521 to
6a63e79
Compare
6a63e79 to
005a320
Compare
005a320 to
1c9f40b
Compare
1c9f40b to
a8ae7bf
Compare
a8ae7bf to
c91d069
Compare
c91d069 to
ccead80
Compare
ccead80 to
e525698
Compare
Signed-off-by: Richard Hoch <rhoch@redhat.com>
6777989 to
cd34bf8
Compare
Resolves https://redhat.atlassian.net/browse/MTV-5019 by verifying that the described errors exist and fixing the ones that do. The Jira referred to a number of extra periods (.) in the text, but I could not find them in the Asciidoc files.
Previews:
Summary by CodeRabbit
Documentation