-
Notifications
You must be signed in to change notification settings - Fork 22
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
🐾 In providers forms, missing explanation for invalid field #646
Comments
doc team contact: @RichardHoch |
cc:// @RichardHoch @anarnold97 |
changing from bug to feature, to indicate it is not a bug |
@sgratch hi
b. please follow PF4 suggestion on how to write help texts:
see: https://www.patternfly.org/ux-writing/error-messages for more information for example, when we describe what is wrong with a "name" input, we should be brief, we should not try to write the complete definition of RFC 1123 but we can say the name should be valid k8s name, ask the user to verify, and if possible give them a link for our or k8s documentation. for example if the name is invalid (not if it's not uniqe) a posible help text can be:
|
Note: in some future we can make the help text specific for the error, for example if an input include space when it should not, we can change the "What happen" and "How to solve" to "the X include space, remove the spaces and try again" |
submitted and merged upstream: #712 |
update help message for oVirt URL: |
update help message for vSphere URL: |
#756 - fix msg in VDDK input |
Reference: kubev2v#646 Reference: kubev2v#541 Rephrase all oVirt fields help text messages and add hints for the following dialogs: 1. Create oVirt provider, 2. oVirt Credentials view/edit modes. The main changes include: 1. Rephrase all help text messages. 2. Support 'warning' validation state for the 'user' field. 3. Add hint sections for insecureSkipVerify, cacert fields. 4. In Create/edit dialogs, hide the 'cacert' field help text message and the hint section if insecureSkipVerify=true. This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Reference: kubev2v#541 Rephrase all oVirt fields help text messages and add hints for the following dialogs: 1. Create oVirt provider, 2. oVirt Credentials view/edit modes. The main changes include: 1. Rephrase all help text messages. 2. Support 'warning' validation state for the 'user' field. 3. Add hint sections for insecureSkipVerify, cacert fields. 4. In Create/edit dialogs, hide the 'cacert' field help text message and the hint section if insecureSkipVerify=true. This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Reference: kubev2v#541 Rephrase all oVirt fields help text messages and add hints for the following dialogs: 1. Create oVirt provider, 2. oVirt Credentials view/edit modes. The main changes include: 1. Rephrase all help text messages. 2. Support 'warning' validation state for the 'user' field. 3. Add hint sections for insecureSkipVerify, cacert fields. 4. In Create/edit dialogs, hide the 'cacert' field help text message and the hint section if insecureSkipVerify=true. This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Rephrase all oVirt fields help text messages and add tooltips for the following dialogs: 1. Create oVirt provider, 2. oVirt Credentials view/edit modes. The main changes include: 1. Rephrase all help text messages. 2. Support 'warning' validation state for the 'user' field. 3. Add tooltips with a helpIcon for insecureSkipVerify, cacert fields. This fix assumes that leaving the 'cacert' field empty, will trigger verifying the the system CA certificates. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Enhance and rephrase the help text fields and validations for following OpenStack dialogs: 1. Create OpenStack provider. 2. OpenStack Credentials view/edit modes. 3. OpenStack details - URL field 4. OpenStack details - URL icon help text Changes include supporting formatted help text. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Enhance and rephrase the help text fields and validations for following OpenStack dialogs: 1. Create OpenStack provider. 2. OpenStack Credentials view/edit modes. 3. OpenStack details - URL field 4. OpenStack details - URL icon help text Changes include supporting formatted help text. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Enhance and rephrase the help text fields and validations for following OpenStack dialogs: 1. Create OpenStack provider. 2. OpenStack Credentials view/edit modes. 3. OpenStack details - URL field 4. OpenStack details - URL icon help text Changes include supporting formatted help text. Signed-off-by: Sharon Gratch <[email protected]>
Reference: kubev2v#646 Enhance and rephrase the help text fields and validations for following OpenStack dialogs: 1. Create OpenStack provider. 2. OpenStack Credentials view/edit modes. 3. OpenStack details - URL field 4. OpenStack details - URL icon help text Changes include supporting formatted help text. Signed-off-by: Sharon Gratch <[email protected]>
…texts to Obj Reference: kubev2v#646 Reference: kubev2v#854 (comment) Reference: kubev2v#861 (comment) A follow up for kubev2v#854 and kubev2v#861 that includes the following fixes: 1. Fix vSphere and oVirt help text fields and code comments, based on doc team review. 2. Replace all reminded <Trans> text appearances from String to React Obj. Signed-off-by: Sharon Gratch <[email protected]>
…texts to Obj Reference: kubev2v#646 Reference: kubev2v#854 (comment) Reference: kubev2v#861 (comment) A follow up for kubev2v#854 and kubev2v#861 that includes the following fixes: 1. Fix vSphere and oVirt help text fields and code comments, based on doc team review. 2. Replace all reminded <Trans> text appearances from String to React Obj. Signed-off-by: Sharon Gratch <[email protected]>
…texts to Obj Reference: kubev2v#646 Reference: kubev2v#854 (comment) Reference: kubev2v#861 (comment) A follow up for kubev2v#854 and kubev2v#861 that includes the following fixes: 1. Fix vSphere and oVirt help text fields and code comments, based on doc team review. 2. Replace all reminded <Trans> text appearances from String to React Obj. Signed-off-by: Sharon Gratch <[email protected]>
…texts to Obj Reference: kubev2v#646 Reference: kubev2v#854 (comment) Reference: kubev2v#861 (comment) A follow up for kubev2v#854 and kubev2v#861 that includes the following fixes: 1. Fix vSphere and oVirt help text fields and code comments, based on doc team review. 2. Replace all reminded <Trans> text appearances from String to React Obj. Signed-off-by: Sharon Gratch <[email protected]>
…texts to Obj Reference: kubev2v#646 Reference: kubev2v#854 (comment) Reference: kubev2v#861 (comment) A follow up for kubev2v#854 and kubev2v#861 that includes the following fixes: 1. Fix vSphere and oVirt help text fields and code comments, based on doc team review. 2. Replace all reminded <Trans> text appearances from String to React Obj. Signed-off-by: Sharon Gratch <[email protected]>
… provider Reference: kubev2v#646 Reference: kubev2v#861 (comment) Fix all comments mentioned by the doc team in kubev2v#861 and applied it to all relevant providers. Signed-off-by: Sharon Gratch <[email protected]>
🎂 🎈 |
Refs:
docs: https://access.redhat.com/documentation/en-us/migration_toolkit_for_virtualization/2.4/html/installing_and_using_the_migration_toolkit_for_virtualization/index
In
create provider form
edit credentials form
we have field validation errors without explanation of what need to be fixed, each error message need to be evaluated with documentation, backend implementatin and validatation code.
a. check validation is correct for this field
b. check validation text is correct for this field
c. add "how to fix" to the text, for exmple "Invalid domain name." if should be "Invalid OpenStack domain name, spaces are not allowed, check that the domain name does not include spaces."
contact Richard from the doc team for specific text where needed.
Screenshot:
The text was updated successfully, but these errors were encountered: