← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1329984] [NEW] improve help messages on modals

 

Public bug reported:


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

** Affects: horizon
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Dashboard (Horizon).
https://bugs.launchpad.net/bugs/1329984

Title:
  improve help messages on modals

Status in OpenStack Dashboard (Horizon):
  New

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/horizon/+bug/1329984/+subscriptions


Follow ups

References