Bug 1584660 - UI text improvement in import cluster workflow
Summary: UI text improvement in import cluster workflow
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat Storage
Component: web-admin-tendrl-ui
Version: rhgs-3.4
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: RHGS 3.4.0
Assignee: Neha Gupta
QA Contact: Daniel Horák
URL:
Whiteboard:
Depends On:
Blocks: 1503137
TreeView+ depends on / blocked
 
Reported: 2018-05-31 12:08 UTC by Rakesh
Modified: 2018-09-04 07:08 UTC (History)
7 users (show)

Fixed In Version: tendrl-ui-1.6.3-6.el7rhgs
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-09-04 07:07:10 UTC
Embargoed:


Attachments (Terms of Use)
UI Text issue (34.47 KB, image/png)
2018-05-31 12:08 UTC, Rakesh
no flags Details
Import Cluster page - updated text (12.01 KB, image/png)
2018-07-13 09:49 UTC, Daniel Horák
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Github Tendrl ui issues 998 0 None None None 2018-06-21 07:14:01 UTC
Red Hat Bugzilla 1588650 0 unspecified CLOSED discovered host(s) section in import cluster screen is slightly inconsistent/misleading 2021-02-22 00:41:40 UTC
Red Hat Product Errata RHSA-2018:2616 0 None None None 2018-09-04 07:08:05 UTC

Internal Links: 1588650

Description Rakesh 2018-05-31 12:08:51 UTC
Created attachment 1446246 [details]
UI Text issue

Description of problem:

The import cluster interface has the following broken sentence:

"Review the hosts for the and click import to monitor this cluster."

It is not clear review the hosts for what? 

Suggestions:
Altogether remove the sighted UI text as it will be mentioned in the docs. Or, make it clear by saying: "Review the hosts and click import to monitor this cluster."


Version-Release number of selected component (if applicable):

carbon-selinux-1.5.4-2.el7rhgs.noarch
collectd-5.7.2-3.1.el7rhgs.x86_64
collectd-ping-5.7.2-3.1.el7rhgs.x86_64
etcd-3.2.7-1.el7.x86_64
libcollectdclient-5.7.2-3.1.el7rhgs.x86_64
python-carbon-0.9.15-2.1.el7rhgs.noarch
python-etcd-0.4.5-2.el7rhgs.noarch
rubygem-etcd-0.3.0-2.el7rhgs.noarch
tendrl-ansible-1.6.3-4.el7rhgs.noarch
tendrl-api-1.6.3-3.el7rhgs.noarch
tendrl-api-httpd-1.6.3-3.el7rhgs.noarch
tendrl-commons-1.6.3-5.el7rhgs.noarch
tendrl-grafana-plugins-1.6.3-3.el7rhgs.noarch
tendrl-grafana-selinux-1.5.4-2.el7rhgs.noarch
tendrl-monitoring-integration-1.6.3-3.el7rhgs.noarch
tendrl-node-agent-1.6.3-5.el7rhgs.noarch
tendrl-notifier-1.6.3-3.el7rhgs.noarch
tendrl-selinux-1.5.4-2.el7rhgs.noarch
tendrl-ui-1.6.3-2.el7rhgs.noarch


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:

Suggestions:
Altogether remove the sighted UI text as it will be mentioned in the docs. Or, make it clear by saying: "Review the hosts and click import to monitor this cluster."


Additional info:

Comment 2 Martin Bukatovic 2018-06-07 16:57:13 UTC
This could be caused by the fact, that in the design document, the text this
BZ complains about states:

> Review the hosts for the My-Gluster1 and click import to monitor this cluster.

where y-Gluster1  is a name of the cluster, which is being imported.

See: https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/247445416

Ju: Does it make sense to drop the name from the text entirely?

Comment 3 Ju Lim 2018-06-14 14:12:50 UTC
I agree the current text is not too clear and needs to be improved.  See also "Cluster is marked as Ready to import even before all Gluster Hosts are detected" (https://bugzilla.redhat.com/show_bug.cgi?id=1590246), where I suggested we should update the text as well.

Ensure all hosts in the cluster are listed below, then click Import to begin monitoring the cluster.

Rakesh -- does the text work for you?

Comment 4 Rakesh 2018-06-14 16:55:43 UTC
(In reply to Ju Lim from comment #3)
> I agree the current text is not too clear and needs to be improved.  See
> also "Cluster is marked as Ready to import even before all Gluster Hosts are
> detected" (https://bugzilla.redhat.com/show_bug.cgi?id=1590246), where I
> suggested we should update the text as well.
> 
> Ensure all hosts in the cluster are listed below, then click Import to begin
> monitoring the cluster.
> 
> Rakesh -- does the text work for you?

Ju, 

The first part of the text LGTM but I am thinking aloud about the second part - "then click Import to begin monitoring the cluster."

After the user clicks on "Import cluster," the next screen shows that the task is submitted. Then the cluster is imported in the background and after a successful import, it becomes available in WA cluster interface. To actually monitor a cluster, the user needs to click Dashboard and launch the Grafana for real-time monitoring. 

If we say "click Import to 'begin' monitoring the cluster," that implies the monitoring will begin immediately after the "import" button is clicked which is not true as the user has a navigation journey to Grafana for actual monitoring to begin. The user could be surprised/confused that "Hey, the monitoring did not begin after clicking import, did I do something wrong?" :) 

So to avoid misleading/confusing the user, how about keeping it simple and exactly stating what the import button will do in the immediate next scrren: 

"Ensure all hosts in the cluster are listed below, then click Import to import the cluster." OR "Ensure all hosts in the cluster are listed below, then click Import to begin importing the cluster." 
Thoughts?

Comment 5 Ju Lim 2018-06-18 13:30:42 UTC
Let's go with "Ensure all hosts in the cluster are listed below, then click Import to begin importing the cluster."

Comment 7 Daniel Horák 2018-07-13 09:49:13 UTC
Created attachment 1458693 [details]
Import Cluster page - updated text

Comment 8 Daniel Horák 2018-07-13 09:52:51 UTC
The text on Import Cluster page was updated and is the same as acknowledged in
Comment 5 (and also corresponds to the  updated design document[1]):

> Ensure all hosts in the cluster are listed below, then click Import to begin importing the cluster.

Tested with:
  tendrl-ui-1.6.3-6.el7rhgs.noarch

[1] https://redhat.invisionapp.com/share/8QCOEVEY9#/screens/247445416  

> VERIFIED

Comment 10 errata-xmlrpc 2018-09-04 07:07:10 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2018:2616


Note You need to log in before you can comment on or make changes to this bug.