Bug 2173563 - The "YAML view" position is not consistent in VM tabs
Summary: The "YAML view" position is not consistent in VM tabs
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: User Experience
Version: 4.13.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.13.0
Assignee: Hilda Stastna
QA Contact: Guohua Ouyang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-02-27 09:21 UTC by Guohua Ouyang
Modified: 2023-05-18 02:58 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-05-18 02:57:55 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
2 sections (170.28 KB, image/png)
2023-03-09 07:28 UTC, Yifat Menchik
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker CNV-26170 0 None None None 2023-02-27 09:22:33 UTC
Red Hat Product Errata RHSA-2023:3205 0 None None None 2023-05-18 02:58:07 UTC

Description Guohua Ouyang 2023-02-27 09:21:32 UTC
Description of problem:
The "YAML view" position is not consistent in VM tabs:
- In Details, Scheduling, Add disk and Add network interface, it’s next to the title
- In Environment and Scripts, it's above the title


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


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 1 Hilda Stastna 2023-02-28 18:08:31 UTC
Hi Guohua,

can you, please, make sure with the UX this is a bug? Can you, please, also provide the expected behavior? Should it be next to the title or above it?

Anyway, I assume it's about consistency and that you'd probably rather see "YAML" next to the title everywhere, but IMO having it differently in Environment and Scripts tab has good reasons:
- in Environment tab, there's kinda too long title to have that component next to the title: "Include all values from existing config maps, secrets or service accounts (as disk)"
- in Scripts tab, there's no any title at all (only smaller subtitles for the 2 subsections - Cloud-init and Authorized SSH Key)
Thanks.

Comment 2 Guohua Ouyang 2023-02-28 23:22:02 UTC
Hi Ronen,
What do you think, I'm agree with c#1.

Comment 3 Yifat Menchik 2023-03-01 08:06:46 UTC
Hi @hstastna @gouyang @rsdeor  TMO "YAML" should always be next to the title. 

Regarding the Environment and Scripts tabs and in general - TMO it looks odd that some pages include titles (VirtualMachine Details, Scheduling, Disks) and some don't (Environment, Network interfaces, Scripts).
I suggest to add the missing titles in these pages so the "YAML" can always be found next to it.

For the "Environment" tab - TMO the current title "Include all values from existing config maps, secrets or service accounts (as disk)" is too long to act as a title and we can either have it in a smaller font size as a sub-title or shorten it and include the missing info in the popover text.

WDYT?

Comment 4 Ronen 2023-03-01 10:45:09 UTC
@yfrimanm I agree with what you're saying.
This is a UX issue and I will let you make the decision.

Comment 5 Hilda Stastna 2023-03-06 11:43:34 UTC
I mostly agree with Ronen and Yifat. Yifat, how would you shorten that long title? Or smaller font size? Thanks!
Regarding adding missing titles, I am not sure. Does adding those titles add some value for the user? Aren't those titles in there unnecessary? 
I'd go the opposite way - I'd remove all the titles for the tab where there aren't more than 1 (sub)section in the page, to simplify the UI.

Comment 6 Yifat Menchik 2023-03-06 12:17:52 UTC
@hstastna for the "Environment" tab I would suggest the "Environment" as the main title (as we should have in all the other tabs). The subtitle "Include all values from existing config maps, secrets or service accounts (as disk) "should be in a smaller text size.

Comment 7 Hilda Stastna 2023-03-08 15:29:08 UTC
Update:

Regarding Environment, Network interfaces and Scripts tabs, it was decided to add the titles to those tabs.

"YAML" will be placed next to the title - for Scripts and Environment tabs (+ Comment 6 for Environment tab).

Regarding the position of the button to create NICs and the "YAML" in the NICs tab, that's still under the discussion.
We want to keep consistency with other pages/tabs as much as possible.

Comment 9 Guohua Ouyang 2023-03-09 03:26:43 UTC
Let's just adding title to environment and scripts tab in this bug, leave the network interfaces and disks there until we have a clear solution for it.

Comment 10 Yifat Menchik 2023-03-09 07:28:32 UTC
Created attachment 1949233 [details]
2 sections

Comment 11 Yifat Menchik 2023-03-09 07:30:41 UTC
I think we should add it to all the tabs for consistency. Please see the 2 sections attachment.

Comment 12 Hilda Stastna 2023-03-09 10:41:32 UTC
According to the comments above, this bugzilla is going much bigger and far from the original purpose of it.
According to Yifat's suggestion, we should move the whole content of the NICs tab to 2 new sub-sub-tabs.
And because we want to keep consistency in the UI, we should do the same in some other pages:
we have 3 subsections in VM Details tab,
2 subsections in Scripts tab,
2 in the new Diagnostics tab
(and I think same for the Disks tab, not sure).
And that would be much bigger change, far from just "moving the YAML" in the page.

So I suggest to deal with NICs and Disks tabs (and other ones) separately, within a different bugzilla.
WDYT, Guohua? Maybe creating a separate BZ for that worth? Thanks.

Comment 13 Guohua Ouyang 2023-03-09 10:53:38 UTC
Opened a new bug https://bugzilla.redhat.com/show_bug.cgi?id=2176797 for network/disk tab.

Comment 14 Hilda Stastna 2023-03-09 11:08:21 UTC
Thanks a lot for that, Guohua!

Comment 15 Hilda Stastna 2023-03-13 21:08:15 UTC
Fixing:
https://github.com/kubevirt-ui/kubevirt-plugin/pull/1140

Comment 16 Guohua Ouyang 2023-03-27 06:58:40 UTC
verified on 4.13.0

Comment 18 errata-xmlrpc 2023-05-18 02:57:55 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 (Moderate: OpenShift Virtualization 4.13.0 Images security, bug fix, and enhancement update), 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-2023:3205


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