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

🐾 Enhance OCP provider help text fields #847

Merged
merged 1 commit into from
Jan 24, 2024

Conversation

sgratch
Copy link
Contributor

@sgratch sgratch commented Jan 24, 2024

Reference: #646

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

  1. Create OCP provider,
  2. OCP Credentials view/edit modes.
  3. OCP details - URL edit field
  4. OCP details - URL title icon help text

The changes include supporting formatted help text.

Screenshots:

image

image

image

image
image

image

image
image

… fields

Enhance and rephrase the help text fields and validations for following OCP dialogs:
1. Create OCP provider,
2. OCP Credentials view/edit modes.
3. OCP details - URL edit field
4. OCP details - URL title icon help text

The changes includes supporting formatted help text.

Signed-off-by: Sharon Gratch <sgratch@redhat.com>
Copy link

sonarcloud bot commented Jan 24, 2024

Quality Gate Passed Quality Gate passed

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

1 New issue
0 Security Hotspots
No data about Coverage
7.8% Duplication on New Code

See analysis details on SonarCloud

@sgratch sgratch changed the title OEnhabce OCP provider create,view/edit,edit URL and details help text fields Enhabce OCP provider create,view/edit,edit URL and details help text fields Jan 24, 2024
@sgratch
Copy link
Contributor Author

sgratch commented Jan 24, 2024

cc:// @RichardHoch @anarnold97

@sgratch sgratch changed the title Enhabce OCP provider create,view/edit,edit URL and details help text fields Enhance OCP provider create,view/edit,edit URL and details help text fields Jan 24, 2024
@yaacov yaacov changed the title Enhance OCP provider create,view/edit,edit URL and details help text fields 🐾 Enhance OCP provider help text fields Jan 24, 2024
@yaacov yaacov added the enhancement Categorizes issue or PR as related to a new feature. label Jan 24, 2024
@yaacov yaacov added this to the 2.6.0 milestone Jan 24, 2024
@yaacov yaacov merged commit 4c66a1b into kubev2v:main Jan 24, 2024
7 checks passed
@@ -8,6 +8,9 @@
"{{selectedLength}} hosts selected.": "{{selectedLength}} hosts selected.",
"{{vmCount}} VMs selected ": "{{vmCount}} VMs selected ",
"{{vmDone}} of {{vmCount}} VMs migrated": "{{vmDone}} of {{vmCount}} VMs migrated",
"<br>A service account token with cluster admin privileges, required for authenticating the connection to the API server.": "<br>A service account token with cluster admin privileges, required for authenticating the connection to the API server.",
"<br>A service account token with cluster admin privileges, required for authenticating the connection to the API server.<br>If both <strong>URL</strong> and <strong>Service account bearer token</strong> are left blank, the local OpenShift cluster is used.": "<br>A service account token with cluster admin privileges, required for authenticating the connection to the API server.<br>If both <strong>URL</strong> and <strong>Service account bearer token</strong> are left blank, the local OpenShift cluster is used.",
"<br>Error: The format of the provided token is invalid. Ensure the token is a valid kubernetes service account token.": "<br>Error: The format of the provided token is invalid. Ensure the token is a valid kubernetes service account token.",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uppercase K for Kubernetes.

@@ -127,13 +130,12 @@
"Error: The format of the provided CA Certificate is invalid. Ensure the CA certificate format is in a PEM encoded X.509 format.": "Error: The format of the provided CA Certificate is invalid. Ensure the CA certificate format is in a PEM encoded X.509 format.",
"Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and a path. For example: https://rhv-host-example.com/ovirt-engine/api.": "Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and a path. For example: https://rhv-host-example.com/ovirt-engine/api.",
"Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and a path. For example: https://vCenter-host-example.com/sdk.": "Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and a path. For example: https://vCenter-host-example.com/sdk.",
"Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and optionally a port. For example: <1>https://api.&#8249;your-openshift-domain&#8250;:6443</1> .": "Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and optionally a port. For example: <1>https://api.&#8249;your-openshift-domain&#8250;:6443</1> .",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...name, and, optionally, a port." (appears twice)

<Trans t={t} ns="plugin__forklift-console-plugin">
{
'Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and optionally a port. For example: '
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...name, and, optionally, a port."

}
<ExternalLink href="https://api.<your-openshift-domain>:6443" isInline hideIcon>
https://api.&#8249;your-openshift-domain&#8250;:6443
</ExternalLink>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...name, and, optionally, a port."

<span className="forklift-edit-modal-field-error-validation">
<Trans t={t} ns="plugin__forklift-console-plugin">
{
'Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and optionally a port. For example: '

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...name, and, optionally, a port."

<Trans t={t} ns="plugin__forklift-console-plugin">
{
'<br>Error: The format of the provided token is invalid. Ensure the token is a valid kubernetes service account token.'
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uppercase K for Kubernetes.

<Trans t={t} ns="plugin__forklift-console-plugin">
{
'Error: The format of the provided URL is invalid. Ensure the URL includes a scheme, a domain name, and optionally a port. For example: '
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...name, and, optionally, a port."

sgratch added a commit to sgratch/forklift-console-plugin that referenced this pull request Jan 25, 2024
A follow up for kubev2v#847 that includes the follwing fixes:
- Fixing text fields based on doc team review.
- Removing leading <br> tags from few text fields.
- Replacing external links within the help text with formatted bolded text for url examples.
- Making the help text fields shorter as possible, within one line.

Signed-off-by: Sharon Gratch <sgratch@redhat.com>
This pull request was closed.
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.

3 participants