Bug 1583633 - [Docs] Assign-profile-analysis-task-action confusing documentation.
Summary: [Docs] Assign-profile-analysis-task-action confusing documentation.
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.9.0
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: GA
: 5.9.3
Assignee: Suyog Sainkar
QA Contact: Dayle Parker
URL:
Whiteboard: core
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-05-29 11:57 UTC by Ilanit Stein
Modified: 2018-06-05 06:18 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-06-05 06:18:53 UTC
Category: Bug
Cloudforms Team: CFME Core
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
actions_1.png (92.36 KB, image/png)
2018-05-29 12:02 UTC, Ilanit Stein
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1578121 0 high CLOSED [RHV] SSA is not retrieving file information from VM on RHV 2022-07-09 09:52:42 UTC

Internal Links: 1578121

Description Ilanit Stein 2018-05-29 11:57:08 UTC
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.6/html/assigning_a_custom_analysis_profile_to_a_virtual_machine/index

Section Number and Name: 
3. Creating a Virtual Machine Control Policy   ,
 
16. In Order of Actions if ALL Conditions are True, select the action created in Section 2, “Creating an Action to Assign the Virtual Machine Analysis Profile to the Analysis Task” from the Available Actions list. This action will take place if the resources meet the conditions of the policy.

Under this section there is the attached image "actions_1.png"


Describe the issue: 
The problem is that in this screenshot, action "Assign VM analysis profile..."  is chosen.

Mistakenly, my understanding was that I should look for this same action,
on the list.
and it wasn't there (since this chosen action was such created on the fly, and not there out of the box), 
On the current list additional action was added (appearing at the top of the list): "Annotate image with scan results..." 
So I thought I should choose this one instead.

It think the source of this confusion is:
1. The name given to the displayed chosen action: "Assign VM analysis profile..."
2. The fact that the action list not updated (current list contain "Annotate image with scan results..." at the top) 

Of course, I should have chosen the action that I created in previous section in this doc.

Suggestions for improvement: 
1. Name the chosen action in the screen shot something like "Created action"
2. Use a more up to date screen shot, from CF-4.6, where "Annotate image with scan results..." is at the top.

Additional information: 
I am opening this bug, after I found out I wasn't the only one that was confused.

Comment 1 Ilanit Stein 2018-05-29 12:02:45 UTC
Created attachment 1445371 [details]
actions_1.png

Comment 3 Andrew Dahms 2018-05-31 01:27:04 UTC
Assigning to Suyog for review.


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