Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace VDDK image hint sections with rephrased warning alert sections #1459

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sgratch
Copy link
Collaborator

@sgratch sgratch commented Feb 5, 2025

Reference: https://issues.redhat.com/browse/MTV-1783

📝 Description

Replace VDDK image hint sections with warning alert sections and rephrased the text to emphasize the importance of setting VDDK image value from performace reasons.
Trying to be aligned with doc https://issues.redhat.com/browse/MTV-1782.

🎥 Demo

Before

Screenshot from 2025-02-05 21-28-07

Screenshot from 2025-02-05 21-28-23
Screenshot from 2025-02-05 21-28-49
Screenshot from 2025-02-05 21-29-06

After

Screenshot from 2025-02-05 21-25-38
Screenshot from 2025-02-05 21-26-19
Screenshot from 2025-02-05 21-27-00

Screenshot from 2025-02-05 21-27-14

📝 CC://

@RichardHoch @anarnold97

Reference: https://issues.redhat.com/browse/MTV-1783

Replace VDDK image hint sections with warning alert sections and
rephrased the text to emphasize the importance of setting VDDK image
value from performace reasons. Trying to be aligned with doc
https://issues.redhat.com/browse/MTV-1782.

Signed-off-by: Sharon Gratch <sgratch@redhat.com>
@sgratch sgratch added the enhancement Categorizes issue or PR as related to a new feature. label Feb 5, 2025
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 36.32%. Comparing base (13484d0) to head (50ecf28).
Report is 218 commits behind head on main.

Files with missing lines Patch % Lines
...ls/EditProviderVDDKImage/EditProviderVDDKImage.tsx 33.33% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1459      +/-   ##
==========================================
- Coverage   36.81%   36.32%   -0.50%     
==========================================
  Files         158      156       -2     
  Lines        2548     2522      -26     
  Branches      599      603       +4     
==========================================
- Hits          938      916      -22     
+ Misses       1428     1424       -4     
  Partials      182      182              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@anarnold97
Copy link
Contributor

@RichardHoch - please can you review the wording in this as well
Thanks

@RichardHoch
Copy link

@sgratch This is the current full warning message in the documentation:

It is strongly recommended to create a VMware Virtual Disk Development Kit (VDDK) image in a secure registry that is accessible to all clusters. A VDDK image accelerates migration and reduces the risk of a plan failing. If you are not using VDDK and a plan fails, then retry with VDDK installed. For more information, see xref:../master.adoc#creating-vddk-image_vmware[Creating a VDDK image].

Suggestions:

Tooltip: 2nd paragraph, change to "To accelerate migration and reduce the risk of a plan failing,..."

Window:

Warning: "It is strongly recommended to use a VDDK image. Not using a VDDK image could result in significantly lower migration speeds or a plan failing. For more information, see xref:../master.adoc#creating-vddk-image_vmware[Creating a VDDK image]." (not sure if you format a link differently...)

Text below text box: "The VDDK image is empty. It is strongly recommended to provide an image using the following format: ... "

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants