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 OVA provider help text fields #848

Merged
merged 1 commit into from
Jan 28, 2024

Conversation

sgratch
Copy link
Collaborator

@sgratch sgratch commented Jan 25, 2024

Reference: #646

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

  1. Create OVA provider,
  2. OCP details - URL title icon help text

Changes include supporting formatted help text.

Screenshots

Screenshot from 2024-01-28 13-21-46
Screenshot from 2024-01-28 13-22-15
Screenshot from 2024-01-28 13-22-34
Screenshot from 2024-01-28 13-21-10

@sgratch
Copy link
Collaborator Author

sgratch commented Jan 25, 2024

cc:// @RichardHoch @anarnold97

Copy link
Member

@yaacov yaacov left a comment

Choose a reason for hiding this comment

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

help texts should be one line, we have a different issue for multi line help texts #

@sgratch
Copy link
Collaborator Author

sgratch commented Jan 25, 2024

help texts should be one line, we have a different issue for multi line help texts #

I wondered about that as well and wanted your feedback.
From user point of view, it's much nicer to have it split into few lines, but I was not sure about the standard.

I will try one line since a tooltip looks overheaded here.

@yaacov
Copy link
Member

yaacov commented Jan 25, 2024

it's much nicer to have it split into few lines,

You should not have a text that can be split up, if it can be split to two lines it's too long.
The help is not intended to replace documentation, it's a short help text for the input 4 or 5 words, if it's more then that, it's probably not a help text for an input field.

we have a different task, for longer help hints #541

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

1. Create OVA provider,
2. OCP details - URL title icon help text

Changes include supporting formatted help text.

Signed-off-by: Sharon Gratch <[email protected]>
@sgratch sgratch force-pushed the enhance-ova-provider-help-text-fields branch from ea0d99a to 7974686 Compare January 28, 2024 11:19
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

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

See analysis details on SonarCloud

@yaacov yaacov merged commit f9662bc into kubev2v:main Jan 28, 2024
7 checks passed
@sgratch sgratch deleted the enhance-ova-provider-help-text-fields branch January 28, 2024 13:13
URL of the NFS file share that serves the OVA.{'<br><br>'}
Ensure the URL is in the following format: {'<strong>'}nfs_server:/nfs_path
{'</strong>'}, where:{'<br>'}
{'<strong>'}nfs_server:{'</strong>'} An IP or hostname of the server where the share
Copy link

@RichardHoch RichardHoch Jan 28, 2024

Choose a reason for hiding this comment

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

Maybe "the"?

Copy link
Collaborator Author

@sgratch sgratch Jan 28, 2024

Choose a reason for hiding this comment

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

@RichardHoch Do you mean replacing "An IP or hostname of.."
with: "The IP or hostname of..." ?

Choose a reason for hiding this comment

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

@sgratch Yes, that is my suggestion if in Hebrew you would say "ה" If not, then it's fine as is.

@RichardHoch
Copy link

@yaacov @sgratch One small question; otherwise LGTM.
But ... can you send me the text that appears under "Create Provider" ("Create by using...")? I think it needs a little fixing, even though I see there is a space issue.

@sgratch
Copy link
Collaborator Author

sgratch commented Jan 28, 2024

@yaacov @sgratch One small question; otherwise LGTM. But ... can you send me the text that appears under "Create Provider" ("Create by using...")? I think it needs a little fixing, even though I see there is a space issue.

@RichardHoch
You refer to this text?:

'Create by using the form or manually entering YAML or JSON definitions, Provider CR stores attributes that enable MTV to connect to and interact with the source and target providers.',

@RichardHoch
Copy link

@yaacov @sgratch One small question; otherwise LGTM. But ... can you send me the text that appears under "Create Provider" ("Create by using...")? I think it needs a little fixing, even though I see there is a space issue.

@RichardHoch You refer to this text?:

'Create by using the form or manually entering YAML or JSON definitions, Provider CR stores attributes that enable MTV to connect to and interact with the source and target providers.',

Yes, please.

@sgratch
Copy link
Collaborator Author

sgratch commented Jan 29, 2024

@yaacov @sgratch One small question; otherwise LGTM. But ... can you send me the text that appears under "Create Provider" ("Create by using...")? I think it needs a little fixing, even though I see there is a space issue.

@RichardHoch You refer to this text?:

'Create by using the form or manually entering YAML or JSON definitions, Provider CR stores attributes that enable MTV to connect to and interact with the source and target providers.',

Yes, please.

@RichardHoch
The original text is:
Create by using the form or manually entering YAML or JSON definitions, Provider CR stores attributes that enable MTV to connect to and interact with the source and target providers.

This is not part of this PR but will be fixed if needed. What are your comments for this text?

@RichardHoch
Copy link

RichardHoch commented Jan 29, 2024

@sgratch "Create Providers by using the form or manually entering YAML or JSON definitions. Provider CRs store attributes that enable MTV to connect to and interact with the source and target providers."

sgratch added a commit to sgratch/forklift-console-plugin that referenced this pull request Jan 29, 2024
sgratch added a commit to sgratch/forklift-console-plugin that referenced this pull request Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants