🐾 Enhance vSphere provider help text fields #854

sgratch · 2024-01-29T15:32:56Z

Reference: #646

Enhance and rephrase the help text fields and validations for following vSphere dialogs:

Create vSphere provider - URL, VDDK, username, password.
vSphere Credentials view/edit modes - username, password.
vSphere details - URL and VDDK edit fields
vSphere details - URL and VDDK titles icon help text

Changes include supporting formatted help text.

Note that handling the fingerprint and skip ca validation fields will be done as part of
#827.

Screenshots:

sgratch · 2024-01-29T15:33:12Z

cc:// @RichardHoch @anarnold97

yaacov · 2024-01-29T16:52:00Z

@sgratch hi, the help texts should fit in one line, can you find a shorter phrasing for the vddk help texts?

Enhance and rephrase the help text fields and validations for following vSphere dialogs: 1. Create vSphere provider - URL, VDDK init image, username, password. 2. vSphere Credentials view/edit modes - username, password. 3. vSphere details - URL and VDDK edit fields 4. vSphere details - URL and VDDK titles icon help text Changes include supporting formatted help text. Note that handling the fingerprint and skip ca validation fields will be done as part of kubev2v#827. Signed-off-by: Sharon Gratch <[email protected]>

sonarqubecloud · 2024-01-29T17:42:59Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

2 New issues
0 Security Hotspots
No data about Coverage
1.9% Duplication on New Code

See analysis details on SonarCloud

sgratch · 2024-01-29T17:44:52Z

@sgratch hi, the help texts should fit in one line, can you find a shorter phrasing for the vddk help texts?

@yaacov added a tooltip and moved the recommendation to the modal's body:

RichardHoch · 2024-01-30T09:37:51Z

...e-plugin/src/modules/Providers/utils/validators/secret-fields/vsphereSecretFieldValidator.ts

@@ -11,6 +11,7 @@ import { validateFingerprint, validateNoSpaces } from '../common';
 * 'default' - The default state of the form field, used when the field is empty or a value hasn't been entered yet.
 * 'success' - The field's value has passed validation.
 * 'error' - The field's value has failed validation.
+ * 'warning' - The field's value might fail the validation, but it's not mandatory and not disabling the form saving.
 */


...but the field is not mandatory and if it fails, the form saving will not be disabled."

Correct. It's just a comment for explaining the warning validation state.
In case of a warning validation result for a field - a message will appear but the form saving will not be disabled.

The field's value might fail the validation, but it's not mandatory and not disabling the form saving.

the reason the "create" is not disabled is because the value is valid and will be used as it is.
using this phrasing, it seams like the value is not valid, but we allow it anyways, but this is not true.

a better phrasing will be:

The field's value is valid but does not fit the standard format, continue if you know what you are doing

RichardHoch · 2024-01-30T09:41:38Z

...ugin/src/modules/Providers/views/details/components/DetailsSection/VSphereDetailsSection.tsx

-            )}
+            <Trans t={t} ns="plugin__forklift-console-plugin">
+              {
+                'URL of the API endpoint of the vCenter on which the source VM is mounted. Ensure that the URL includes the sdk path, usually <strong>/sdk</strong>. For example, <strong>https://vCenter-host-example.com/sdk</strong>. If a certificate for FQDN is specified, the value of this field needs to match the FQDN in the certificate.'


Does sdk need formatting tags?
2 For example: instead of For example,

I think it's nicer to make the sdk path bold..to emphasis it's a reserved word.

RichardHoch · 2024-01-30T09:42:26Z

...iders/views/details/components/CredentialsSection/components/edit/VSphereCredentialsEdit.tsx

+        <Trans t={t} ns="plugin__forklift-console-plugin">
+          {
+            "Error: The format of the provided user name is invalid. Ensure the user name doesn't include whitespace characters."
+          }


"does noit" is better.

RichardHoch · 2024-01-30T09:45:32Z

...e-plugin/src/modules/Providers/utils/validators/secret-fields/vsphereSecretFieldValidator.ts

@@ -11,6 +11,7 @@ import { validateFingerprint, validateNoSpaces } from '../common';
 * 'default' - The default state of the form field, used when the field is empty or a value hasn't been entered yet.


"has not" is better.

This is an internal comment, but will fix anyway.

RichardHoch · 2024-01-30T09:45:58Z

...iders/views/details/components/CredentialsSection/components/edit/VSphereCredentialsEdit.tsx

+  const passwordHelperTextMsgs = {
+    error: t(
+      "Error: The format of the provided user password is invalid. Ensure the user password doesn't include whitespace characters.",
+    ),


"does not" is better.

RichardHoch · 2024-01-30T09:46:44Z

@sgratch @yaacov A couple minor points, but otherwise LGTM!

…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 force-pushed the enhance-vSphere-provider-help-text-fields branch from 328dc54 to 5d6e43e Compare January 29, 2024 17:42

yaacov approved these changes Jan 29, 2024

View reviewed changes

yaacov changed the title ~~Enhance vSphere provider help text fields~~ 🐾 Enhance vSphere provider help text fields Jan 29, 2024

yaacov added the enhancement Categorizes issue or PR as related to a new feature. label Jan 29, 2024

yaacov added this to the 2.6.0 milestone Jan 29, 2024

yaacov merged commit 4557cb8 into kubev2v:main Jan 29, 2024
7 checks passed

sgratch deleted the enhance-vSphere-provider-help-text-fields branch January 29, 2024 18:12

RichardHoch reviewed Jan 30, 2024

View reviewed changes

sgratch mentioned this pull request Jan 30, 2024

🧼 Fix few text fields based on doc team review, replace reminded Trans texts to Obj #865

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐾 Enhance vSphere provider help text fields #854

🐾 Enhance vSphere provider help text fields #854

sgratch commented Jan 29, 2024

sgratch commented Jan 29, 2024

yaacov commented Jan 29, 2024

sonarqubecloud bot commented Jan 29, 2024

sgratch commented Jan 29, 2024 •

edited

Loading

RichardHoch Jan 30, 2024

sgratch Jan 30, 2024

yaacov Jan 30, 2024

RichardHoch Jan 30, 2024 •

edited

Loading

sgratch Jan 30, 2024

RichardHoch Jan 30, 2024

RichardHoch Jan 30, 2024

sgratch Jan 30, 2024

RichardHoch Jan 30, 2024

RichardHoch commented Jan 30, 2024

		@@ -11,6 +11,7 @@ import { validateFingerprint, validateNoSpaces } from '../common';
		* 'default' - The default state of the form field, used when the field is empty or a value hasn't been entered yet.

🐾 Enhance vSphere provider help text fields #854

🐾 Enhance vSphere provider help text fields #854

Conversation

sgratch commented Jan 29, 2024

Screenshots:

sgratch commented Jan 29, 2024

yaacov commented Jan 29, 2024

sonarqubecloud bot commented Jan 29, 2024

Quality Gate passed

sgratch commented Jan 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RichardHoch Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RichardHoch commented Jan 30, 2024

sgratch commented Jan 29, 2024 •

edited

Loading

RichardHoch Jan 30, 2024 •

edited

Loading