Bug 1260962

Summary: [help] Run Once help icon points to useless doc
Product: Red Hat Enterprise Virtualization Manager Reporter: Jiri Belka <jbelka>
Component: rhevm-docAssignee: Greg Sheremeta <gshereme>
Status: CLOSED CURRENTRELEASE QA Contact: Petr Matyáš <pmatyas>
Severity: low Docs Contact:
Priority: low    
Version: 3.6.0CC: adahms, gklein, gshereme, lbopf, lsurette, michal.skrivanek, oourfali, pmatyas, pstehlik, rbalakri, Rhev-m-bugs, sbonazzo, srevivo, thildred, ykaul
Target Milestone: ovirt-4.0.2   
Target Release: 4.0.2   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1334412 (view as bug list) Environment:
Last Closed: 2016-07-27 12:44:49 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: UX RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1336262    
Bug Blocks: 1334412    
Attachments:
Description Flags
run_once_virtual_machine - fixed
none
run_once_vm - userportal - fixed
none
run once dialogue screenshot none

Description Jiri Belka 2015-09-08 10:03:29 UTC
Description of problem:

In Run Once dialog after clicking (?) help icon almost useless doc page is opened https://$engine_fqdn/ovirt-engine/docs/manual/en-US/html/Administration_Guide/sect-Running_Virtual_Machines.html

It is useless as it doesn't explain anything about various options in Run Once dialog. I suppose valid url should be:

https://$engine_fqdn/ovirt-engine/docs/manual/en-US/html/Administration_Guide/sect-Explanation_of_Settings_and_Controls_in_the_New_Virtual_Machine_and_Edit_Virtual_Machine_Windows.html#Virtual_Machine_Initial_Run_settings_explained

Version-Release number of selected component (if applicable):
rhevm-webadmin-portal-3.6.0-0.13.master.el6.noarch

How reproducible:
100%

Steps to Reproduce:
1. Run Once dialog -> click (?) help icon
2. observe the doc
3.

Actual results:
mostly useless for Run Once dialog features

Expected results:
an user should see a documentation which explain all the features of Run Once dialog

Additional info:

Comment 1 Einav Cohen 2015-09-09 16:17:05 UTC
I assume the problem is in the CSH mapping file; I believe it is way too early to text any CSH in RHEV-3.6. Once the 3.6 documentation would be more stable, we will update the CSH mapping file, and CSH-links-related problems would then be eliminated. 

[@Greg - worth checking with the documentation team where they stand with the 3.6 documentation and when would be a good time to do an initial 3.6 rhevm-docs build (a "real" one, that contains 3.6 books - not 3.5 books) and, as part of the process, update the CSH mapping accordingly.

Comment 2 Greg Sheremeta 2016-02-12 02:16:30 UTC
The 3.6 mapping file (updated today) currently maps this one to:

Virtual_Machine_Management_Guide/sect-Starting_the_Virtual_Machine.html

@Lucy or Andrew, is there a better, more specific document for "Run Once"? If not, I consider this fixed.

Comment 3 Lucy Bopf 2016-02-15 06:16:46 UTC
Hi Greg,

I think the best reference for the 'Run Once' button is the following:

Virtual_Machine_Management_Guide/Virtual_Machine_Run_Once_settings_explained.html

It looks like what we're referring to as the 'Run Once dialog' is referred to in the mapping file by the actual name of the dialog that the 'Run Once' button opens, "; VMs Tab > Run Virtual Machine(s)". The dialog name may not have been familiar, so the link has been updated to point to more generic information about starting a virtual machine.

We can make sure that this link is updated in the mapping file, but are we also able to update the description for that help text to something like "; VMs Tab > Run Virtual Machine(s) dialog (Run Once)"?


Lucy

Comment 4 Greg Sheremeta 2016-02-19 22:21:31 UTC
I changed the helptag to "run_once_virtual_machine", changed the string to "VMs Tab > Run Once", and changed the URL to "Virtual_Machine_Management_Guide/Virtual_Machine_Run_Once_settings_explained.html"

see screenshot for verification that it works.

Comment 5 Greg Sheremeta 2016-02-19 22:23:39 UTC
Created attachment 1128676 [details]
run_once_virtual_machine - fixed

Comment 8 Petr Matyáš 2016-02-25 15:41:20 UTC
Although this works correctly in webadmin, it leads to the old site in userportal, which causes inconsistency and IMO should be fixed in userportal as well.

Tested on 3.6.3-4

Comment 10 Greg Sheremeta 2016-03-03 21:27:48 UTC
Created attachment 1132911 [details]
run_once_vm - userportal - fixed

Comment 11 Petr Matyáš 2016-03-31 09:26:42 UTC
Created attachment 1142127 [details]
run once dialogue screenshot

Well, now the icon is not visible in userportal at all.

Comment 12 Petr Matyáš 2016-03-31 09:27:36 UTC
Tested on 3.6.5-1

Comment 13 Greg Sheremeta 2016-03-31 12:02:29 UTC
What version of rhevm-doc is installed on the machine where you tested?

Comment 14 Petr Matyáš 2016-03-31 13:32:34 UTC
rhevm-doc-3.6.0-4.el6eng.noarch

Comment 15 Greg Sheremeta 2016-04-01 17:53:12 UTC
Hmm, just a build timing issue I think. The next version of rhevm-doc has the fix. Let's try again with the next build if you have time, or if not, 3.6.6 is fine.

Comment 16 Petr Matyáš 2016-04-05 15:04:29 UTC
I tested again on 3.6.5-2 and the icon appears correctly and leads to the right website on both webadmin and userportal.

Comment 18 Yaniv Lavi 2016-05-01 09:37:14 UTC
Can you please clone the bug?

Comment 24 Gil Klein 2016-07-27 12:44:49 UTC
This bug was fixed and is slated to be in the upcoming version. As we
are focusing our testing at this phase on severe bugs, this bug was
closed without going through its verification step. If you think this
bug should be verified by QE, please set its severity to high and move
it back to ON_QA