Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 903684

Summary: webadmin [TEXT]: alert message for changing Quota to enforce is too long
Product: Red Hat Enterprise Virtualization Manager Reporter: Dafna Ron <dron>
Component: ovirt-engine-webadmin-portalAssignee: ofri <omasad>
Status: CLOSED CURRENTRELEASE QA Contact: Pavel Stehlik <pstehlik>
Severity: high Docs Contact:
Priority: unspecified    
Version: 3.2.0CC: acathrow, chetan, dfediuck, dyasny, ecohen, hateya, iheim, lnovich, oramraz, Rhev-m-bugs, sgrinber, ykaul
Target Milestone: ---   
Target Release: 3.2.0   
Hardware: x86_64   
OS: Linux   
Whiteboard: sla
Fixed In Version: sf8 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: SLA RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
screen shot none

Description Dafna Ron 2013-01-24 15:03:30 UTC
Created attachment 686821 [details]
screen shot

Description of problem:

the message that appears when we edit the DC quota to enforce or audit is too long. 
also, I would have someone who is a native english speaker or a technical writer take a look at it because the message also appears to have a lot of grammar or articulation seems off to me. 
  
Version-Release number of selected component (if applicable):

sf4

How reproducible:

100%

Steps to Reproduce:
1. edit a DC
2. change Quota to enforce/audit mode
3.
  
Actual results:

we get a very long message which should also be looked at by a technical writer

Expected results:

we should have a short and precise message.

here is the message:  

Additional info: screen shot 

You are about to enable the Data Center Quota Enforcement. Since No Quota allocations are defined for this Data Center, engine users will not be able run VMs or create new disks.
Currently running VMs will keep running.

Use Audit mode in order to get the alerts without actually blocking the users. Once ready, you can move Quota from Audit to Enforcing mode to actually block Quota violations.

In order to define quota allocations, go to quota main tab, or in Data Center tab choose quota sub-tab. Use the add button in order to define a new quota allocation. Note that this can be done regardless of Quota state being enabled or disabled.

Are you sure you want to continue?

Comment 1 Doron Fediuck 2013-01-26 11:29:07 UTC
Dafna,
I'm fine with having a tech-writer looking into it.

As for message length, this is a confirmation dialog, and as such should give all relevant information to the user. This means what's being done, possible implications and how to avoid if needed. This is exactly why we use a special dialog and not a plane event notification. So in this view the length is by design.

Please let me know if you saw something inaccurate. I'll make sure to fix it and have a writer rephrase as needed.

Comment 2 Dafna Ron 2013-01-27 13:32:50 UTC
(In reply to comment #1)
> Dafna,
> I'm fine with having a tech-writer looking into it.
> 
> As for message length, this is a confirmation dialog, and as such should
> give all relevant information to the user. This means what's being done,
> possible implications and how to avoid if needed. This is exactly why we use
> a special dialog and not a plane event notification. So in this view the
> length is by design.

but why not adding a link to the guide with this message? or link the audit/enforce mode to their place in the guide? 
I do not think that anyone will actually read this since its too long... 


> 
> Please let me know if you saw something inaccurate. I'll make sure to fix it
> and have a writer rephrase as needed.

examples: 

1. The use of capital letters in the sentence is incorrect 
2. the formatting does not look right (I am not a technical writer but it looks very disorganized) 
3. ' Currently running VMs will keep running.' - does not sound right. 
4. 'Use Audit mode in order to get the alerts without actually blocking the users. Once ready, you can move Quota from Audit to Enforcing mode to actually block Quota violations.' - the word 'actually' in both sentences sounds odd.

Comment 3 Laura Novich 2013-01-28 15:04:33 UTC
You are about to enable the Data Center Quota Enforcement. As Quota allocations have not been defined for this Data Center, engine users will not be able run VMs or create new disks.

Live VMs will not be terminated.

you can use the Audit mode in order to receive alerts without blocking users. Once you are sure you have made all of the changes you need, you can move the Quota settings from Audit to Enforcing mode to prevent Quota violations.

In order to define quota allocations, go to the Quota main tab, or in Data Center tab choose the Quota sub-tab. Use the Add button in order to define a new quota allocation. Note that the quota settings can be changed even if the Quota state is disabled.

Are you sure you want to continue?

This is my suggestion - but Cheryn can give more insight as she actually works on RHEV materials

Cheryn? Thoughts??
It is a bit long and I am not sure if we need to supply ALL of this information...

Thanks for asking me to help
Laura

Comment 4 Laura Novich 2013-01-28 15:06:23 UTC
I think we do not need to supply how-to's in a warning screen - the user should be referred to the documentation but I am not sure if this is done elsewhere...

Comment 5 Cheryn Tan 2013-01-28 23:08:10 UTC
Thank you for bringing this to my attention Laura. I agree, I think users can be pointed to the docs for instructions on configuring quota -- this is covered in the RHEV Administration Guide [1]. 

I'd make a few tweaks to the message:

"You are about to enforce Quota on this Data Center. As Quota allocations have not been defined for this Data Center, users will not be able run VMs or create new disks. 

You can use the Audit mode to receive alerts without blocking users. When you have made all the changes required, you can change the Quota settings from Audit to Enforcing mode to prevent Quota violations. For information on allocating Quota, refer to the Red Hat Enterprise Virtualization Administration Guide.

Are you sure you want to continue?"

[1] https://access.redhat.com/knowledge/docs/en-US/Red_Hat_Enterprise_Virtualization/3.1/html-single/Administration_Guide/index.html#chap-Quotas

Comment 13 Oded Ramraz 2013-03-03 19:43:05 UTC
Moving Quota to Enforce Mode
All the templates, virtual machines, and disks must be assigned into specific quota allocations otherwise will be unusable.
Users should be added as quota consumers.

Please consider using Audit mode until you define Quotas for the users.

Are you sure you want to continue?

(although  I would write Virtual Machines , Templates  , Disks in capital letters same as in Quota )

Verified sf9

Comment 14 Itamar Heim 2013-06-11 08:48:03 UTC
3.2 has been released

Comment 15 Itamar Heim 2013-06-11 08:48:08 UTC
3.2 has been released

Comment 16 Itamar Heim 2013-06-11 08:48:16 UTC
3.2 has been released

Comment 17 Itamar Heim 2013-06-11 08:53:15 UTC
3.2 has been released

Comment 18 Itamar Heim 2013-06-11 09:23:56 UTC
3.2 has been released