Review the labels, description/help, default values, etc. from UI

majguo commented 2 years ago

Overview

The UI of tWAS single server offer origins from the UI of GAed tWAS cluster offer. To simplify the review, the following comparison details is summarized:

Tab Basic: exactly same
- Screenshot (text in the box):
Tab Server configuration vs tab Cluster configuration
- Tab name is changed from Cluster configuration to Server configuration
- Section Number of VMs is removed
- Section Deployment manager server prefix is removed
- Section Managed server prefix is removed
- Section DNS label prefix is changed
  - Default value and tooltip are changed from wasndcluster to was
- Screenshot:
Tab IBM HTTP Server Load Balancer is removed

How to preview the UI

To facilitate the review, reviewers can preview the changes using the Create UI Definition Sandbox:

Open Create UI Definition Sandbox in a new tab of browser;
Download the source code createUiDefinition.json.txt and open it in a text editor;
Replace the content of work area in Create UI Definition Sandbox with the content of source code createUiDefinition.json.txt;
Click Preview at the left-bottom of Create UI Definition Sandbox;

majguo commented 2 years ago

Hello @helyarp @git4rk , could you pls help review the content for tWAS single server offer? Thanks.

edburns commented 2 years ago

Can we consider adding a Yes/No option to provide a public IP address for the single server? Default to Yes.

majguo commented 2 years ago

Thanks @edburns for your comment. @gcharters @m-reza-rahman @NottyCode , feel free to review the UI design of single server by following steps in "How to preview the UI".

git4rk commented 2 years ago

@majguo I reviewed the text and they look good to me.

helyarp commented 2 years ago

@majguo Hi, I like the UI changes. I have a few suggested changes:

Basics tab

Change IBM ID to IBMid. (Cutomers who get an IBM account, get an IBMid. https://www.ibm.com/account)
Change please report them here to open an issue or open an Azure issue.
Change file an issue to open an issue

Question: Why are the links below the sentences and not part of the sentences?

Server configuration tab

No needed changes. VM is acceptable but, if Microsoft typically spells out acronyms, use virtual machine instead.

majguo commented 2 years ago

Thanks @helyarp for your review and suggested changes. Since the original text came from @gcharters & @edburns (e.g., IBM ID is recommended by Graham to replace IBMid), I'd like to make sure all of stakeholders are on the same page and make agreement. Hello Graham & Ed, could you pls take a look at Pam's suggestions above and share your feedback? Thanks.

gcharters commented 2 years ago

@majguo Hi, I like the UI changes. I have a few suggested changes:

Basics tab

Change IBM ID to IBMid. (Cutomers who get an IBM account, get an IBMid. https://www.ibm.com/account)

Change please report them here to open an issue or open an Azure issue.

Change file an issue to open an issue

Question: Why are the links below the sentences and not part of the sentences?

Server configuration tab

No needed changes. VM is acceptable but, if Microsoft typically spells out acronyms, use virtual machine instead.

Hi @helyarp , thanks for the feedback. For the IBMid change, can you confirm that this is how it should be officially referenced? When we investigated previously, there seemed to be no consistency so we just went with IBM ID which seemed to be used on a few official sites.

For the other changes, is the intent that the new suggested text be hyperlinks, or when they still then be followed by the links to the sites? E.g. To use your existing IBM support contact, open an issue with IBM directly.

helyarp commented 2 years ago

@gcharters The IBM Multilingual Terminology database says to use IBMid. The database is IBM internal and lists the accepted terms for IBM doc, products, communication, etc. The IBMid and IBM ID definitions in the database are--

IBMid

noun

An ID that is used to access external IBM products and services.

Usage note: Write as shown--one word, to refer to the user ID for ibm.com.

Comment: IBMid has replaced IBM ID as the preferred form for the SSO process. IBMid is now the untranslated preferred form for all languages.

IBM ID

noun

See: IBMid.

Approval status: Do not use.
Usage note: Use "IBMid."

edburns commented 2 years ago

@helyarp wrote:

Question: Why are the links below the sentences and not part of the sentences?

Answer: this is a limitation of the declarative UI element of the portal. See the Microsoft documentation.

edburns commented 2 years ago

I have filed a cross-repo issue. Please see https://github.com/WASdev/azure.websphere-traditional.cluster/issues/135 .

majguo commented 2 years ago

Thank you all @helyarp @gcharters @edburns . Per all of your inputs, I'd like to make the following changes:

Basics tab

Change IBM ID to IBMid. This change will be applied to all occurrences including template and scripts.
Change please report them here to open an issue.
Change file an issue to open an issue

Besides, I'll also open another PR to apply the above changes to the tWAS cluster offer. You'll see the PR links once they're available later.

majguo commented 2 years ago

Hello @helyarp Would you pls also help review the similar text changes in the other two PRs listed below? Thanks.

helyarp commented 2 years ago

@majguo Hi, changes reviewed and approved!

WASdev / azure.websphere-traditional.singleserver