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

🐾 In providers forms, missing explanation for invalid field #646

Closed
yaacov opened this issue Aug 1, 2023 · 10 comments
Closed

🐾 In providers forms, missing explanation for invalid field #646

yaacov opened this issue Aug 1, 2023 · 10 comments
Assignees
Labels
enhancement Categorizes issue or PR as related to a new feature. providers
Milestone

Comments

@yaacov
Copy link
Member

yaacov commented Aug 1, 2023

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:
missing-explanation-for-invalid-fields

@yaacov yaacov added the bug Categorizes issue or PR as related to a bug. label Aug 1, 2023
@yaacov yaacov added this to the 2.5.0 milestone Aug 1, 2023
@yaacov
Copy link
Member Author

yaacov commented Aug 1, 2023

doc team contact: @RichardHoch

@yaacov
Copy link
Member Author

yaacov commented Aug 1, 2023

cc:// @RichardHoch @anarnold97

@yaacov yaacov added enhancement Categorizes issue or PR as related to a new feature. and removed bug Categorizes issue or PR as related to a bug. labels Aug 14, 2023
@yaacov
Copy link
Member Author

yaacov commented Aug 14, 2023

changing from bug to feature, to indicate it is not a bug

@yaacov
Copy link
Member Author

yaacov commented Sep 8, 2023

@sgratch hi
when fixing the help texts:
a. please note item c in this issue:

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."

b. please follow PF4 suggestion on how to write help texts:

Make your error messages brief yet descriptive. A useful pattern to follow is Description, Reason, and Resolution:

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:

Invalid name, the name does not follow Kubernetes guidelines, check that it only contains lowercase alphanumeric characters, '-' or '.', Lean more {=> link to docs}.

@yaacov
Copy link
Member Author

yaacov commented Sep 8, 2023

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"

@yaacov
Copy link
Member Author

yaacov commented Sep 8, 2023

a. check validation is correct for this field

submitted and merged upstream: #712

@yaacov
Copy link
Member Author

yaacov commented Sep 20, 2023

update help message for oVirt URL:
submitted upstream: #732

@yaacov
Copy link
Member Author

yaacov commented Sep 20, 2023

update help message for vSphere URL:
submitted upstream: #736

@yaacov
Copy link
Member Author

yaacov commented Oct 15, 2023

#756 - fix msg in VDDK input

sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Nov 27, 2023
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Nov 27, 2023
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Nov 28, 2023
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 3, 2024
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]>
@yaacov yaacov changed the title In providers forms, missing explanation for invalid field 🐾 In providers forms, missing explanation for invalid field Jan 17, 2024
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
…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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 30, 2024
…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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 31, 2024
…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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 31, 2024
…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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 31, 2024
…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]>
sgratch added a commit to sgratch/forklift-console-plugin that referenced this issue Jan 31, 2024
… 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]>
@yaacov
Copy link
Member Author

yaacov commented Feb 1, 2024

🎂 🎈

@yaacov yaacov closed this as completed Feb 1, 2024
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. providers
Projects
None yet
Development

No branches or pull requests

2 participants