improve help messages on modals

Bug #1329984 reported by Cindy Lu
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Low
Cindy Lu

Bug Description

It will be a great effort to clean up all the messaging in Horizon, but we can take a first step with some of the help messages. :)

Here are some examples of things to update:
1. "From here you can create a new domain to organize projects, groups and users."
https://github.com/openstack/horizon/blob/master/openstack_dashboard/dashboards/admin/domains/workflows.py#L45

(a) You don't need the first four words.
(b) You shouldn't use "new" when you use the verb "create" because new is implicit when you create.
(c) Insert a comma before "and".
Therefore, the suggested replacement text is as follows:
"Create a domain to organize projects, groups, and users."

We should apply this to other modals as well.

2. We should also avoid using words like "Info." Those should all be replaced with "Information."
Domain Info ==> Domain Information
https://github.com/openstack/horizon/blob/master/openstack_dashboard/dashboards/admin/domains/workflows.py#L43

Other Guidelines:
https://wiki.openstack.org/wiki/UX/Improve_User_Experience_of_Messaging_in_Horizon

Tags: ux
Changed in horizon:
assignee: nobody → Ashish Chandra (ashish-chandra)
Revision history for this message
Ashish Chandra (ashish-chandra) wrote :

Totally agree with you Cindy, greping only "help_text" returns a ton of messages which are not consistent, will try to update as much as I can.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/104334

Changed in horizon:
status: New → In Progress
Julie Pichon (jpichon)
tags: added: ux
Revision history for this message
Cindy Lu (clu-m) wrote :

@Ashish: We got some consensus at the IRC meeting today (http://eavesdrop.openstack.org/meetings/horizon/2014/horizon.2014-07-15-16.01.log.html). YAY! So "Edit the instance details" is good. A few more places to touch up on and it will be perfect!

Revision history for this message
Cindy Lu (clu-m) wrote :

Hi Ashish, any update on this? :)

Changed in horizon:
assignee: Ashish Chandra (ashish-chandra) → Cindy Lu (clu-m)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/104334
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=80d05a5c3d330f5a652ebe75825e91914926c5de
Submitter: Jenkins
Branch: master

commit 80d05a5c3d330f5a652ebe75825e91914926c5de
Author: Ashish Chandra <email address hidden>
Date: Thu Jul 3 01:35:38 2014 +0530

    Improve help messages on modals

    Some general guidelines:
    1. Removed contractions
    2. Changed "Info" to "Information"
    3. Removed the "From here you can..." at the beginning of messages.
    4. Explained concepts to users instead of just reiterating the modal
    title. Thanks Jeff Calcaterra!

    Co-Authored-By: Cindy Lu <email address hidden>
    Closes-Bug: #1329984

    Change-Id: I35af81953cafcbafc28c31b3ce305e8c5e21fe84

Changed in horizon:
status: In Progress → Fix Committed
Cindy Lu (clu-m)
Changed in horizon:
importance: Undecided → Low
milestone: none → juno-3
Thierry Carrez (ttx)
Changed in horizon:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in horizon:
milestone: juno-3 → 2014.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.