Created attachment 1759166 [details] Quick start - Connecting a virtual machine to an external network Created attachment 1759166 [details] Quick start - Connecting a virtual machine to an external network Description of problem: On the "Connecting a virtual machine to an external network" Quick Start, I found it very confusing to follow the content of the first page. There is a Prerequisite section that mentions actions needed to be taken before the user start ("Getting started") with the "Connecting a virtual machine...". But the next section, named "Getting started", also discusses a prerequisite before "Getting started with connecting VM..." Because this section has the same H as the "Prerequisites" means to me that it is separate which is not. The next section is "Getting started with Connecting a virtual machine to an external network". At this point, I am really confused. The previews section was named "Getting started" as well (but getting started with what). It is also worth mentioning that the Prerequisite on this QuickStart does not appear as the rest of the Quick starts Version-Release number of selected component (if applicable): 4.7 How reproducible: 1. you need to have the Virtualization/CNV operator installed for that. 2. Click on the "help" button on the masthead, and select Quick Starts from the dropdown 3. Search for "Connecting a virtual machine to an external network" 4. Click on "Start the tour" to land on the first page Actual results: I'm confused by reading the first card Expected results: If the "Getting started" is a part of the Prerequisite section, make the visualization reflect that. Be more explicit about what "Getting started" refers to. Also, remove the duplication with two sections start with "Getting started" Alin the Prerequisite on this QT to appear as it does on the rest of the QS Additional info:
Looks like a documentation bug Moving to documentation
@yzamir @mcarleto The UXD team should triage this bug. If text editing is required, then the UXD team will collaborate with the writers. The quick starts are owned by the UXD team. The docs team provides text/wording edits and guidance. Unfortunately, the wording and card layout can't be fixed in the documentation repo by the writers. From the bug description, and the image, it sounds like the card titled "Getting Started" is confusing because it provides a link to additional information instead of steps to get started. If edits to wording are required, then the UXD team can collaborate with the writer if needed. -- thank you, Catherine
@Matt, could you please have a look at the comment #2?
I think we need to sync with the docs team on how to improve this. I'd like to pull Yifat into this one so we can align on it. Expect a follow-up on this from us.
Hi, I don't know who is responsible for the quickstarts, moving to management console, please move to the correct component.
These QuickStarts are not part of console or any of its repositories and so we are not their maintainers. Apparently the QuickStarts are installed after installing the Virtualization/CNV operator, there for thy are its dependencies. Moving back to Console Kubevirt Plugin.
Console Kubevirt Plugin is not the maintainer of the quickstarts, moving to CNV installation per comment#6
I am going to set up a meeting with @yfrimanm week of May 24 to resolve this. Will add @mcarleto as optional. We should be able to resolve this very quickly once I can see the interface. cc: @ctomasko Thanks Bob
Met with Yifat Menchik today to discuss this bug. We agree that the first "Getting Started" section which only has a link to existing documentation should be eliminated. The paragraph below the heading should instead be moved under "Prerequisites". This will leave only one Getting Started heading, which is "Getting Started with [_quick start feature name_]". This change should be made for all the Quick Starts so that all have identical formats. If this is an acceptable solution, I will annotate the BZ with this information and we can assign it back to UX for triaging in whatever release they can do the work.
Any update on the question from Bob?
relimele approved of my proposed solution (comment 10) in https://issues.redhat.com/browse/CNV-10998. What needs to happen now is this bug needs to be assigned to UX to actually update the Quick Start UI text as advised. Copying @ctomasko as she may be able to help with the triaging. Thanks, Bob
@bgaydos - The description in Comment 10 is not clear to me. Please explain *exactly* what should be removed and what should be moved. I don't understand which "link" (there are two of them) and what "heading" (there are three).
Met with @nunnatsa this morning via video and walked through the changes. Outstanding question is how we represent the version number in the links in the UX UI Markdown. Currently these are hard coded and must be recoded each release, providing the URL does not change in the doc build (not likely, but it could happen). I will send an email with this question to Yifat, Catherine, and Matt Carleton, and copy Nahshon.
Can you please add to the BZ what was changed exactly? since it is not currently commented here. I need to be able to see that the values are as expected.
@irose - Details are in comment #10
This has been validated against: OpenShift version: 4.8.0-fc.7 Kubernetes version: v1.21.0-rc.0+4b2b6ff Channel: stable-4.8 Cluster ID: 19547860-fd2c-4cac-827d-c0749917e7e0 API server: https://api.infra-inbar.cnv-qe.rhcloud.com:6443
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.8.0 Images), 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-2021:2920