← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1615687] [NEW] Help text in Angular Images workflows is lacking

 

Public bug reported:

The help text in the following angular workflows is very sparse:

- Create Image
- Edit Image
- Create Volume

These files can be found at
openstack_dashboard/static/app/core/images/steps/create-
image/*/*.help.html

We should drop the unnecessary 'Description' header and just use HTML
description lists to explain what each field does, in this format:

https://review.openstack.org/#/c/348969/5/openstack_dashboard/static/app/core/networks/actions
/subnet-details.help.html

This information can just be pulled from the API docs

Note, to enable the angular images panel at this point in time, you will
need to override the default ANGULAR_FEATURES setting. An example of
overriding this setting is here:
https://review.openstack.org/#/c/357041/ In this instance, you will want
to change the setting to True instead of False.

You may also want to base this change on
https://review.openstack.org/#/c/356501/ as it affects the create volume
help file.

** Affects: horizon
     Importance: Wishlist
     Assignee: Bradley Jones (bradjones)
         Status: New


** Tags: angularjs

** Changed in: horizon
     Assignee: (unassigned) => Bradley Jones (bradjones)

** Changed in: horizon
   Importance: Undecided => Wishlist

** Description changed:

  The help text in the following angular workflows is very sparse:
  
  - Create Image
  - Edit Image
  - Create Volume
+ 
+ These files can be found at
+ openstack_dashboard/static/app/core/images/steps/create-
+ image/*/*.help.html
  
  We should drop the unnecessary 'Description' header and just use HTML
  description lists to explain what each field does, in this format:
  
  https://review.openstack.org/#/c/348969/5/openstack_dashboard/static/app/core/networks/actions
  /subnet-details.help.html
  
  This information can just be pulled from the API docs
  
  Note, to enable the angular images panel at this point in time, you will
  need to override the default ANGULAR_FEATURES setting. An example of
  overriding this setting is here:
  https://review.openstack.org/#/c/357041/ In this instance, you will want
  to change the setting to True instead of False.

** Description changed:

  The help text in the following angular workflows is very sparse:
  
  - Create Image
  - Edit Image
  - Create Volume
  
  These files can be found at
  openstack_dashboard/static/app/core/images/steps/create-
  image/*/*.help.html
  
  We should drop the unnecessary 'Description' header and just use HTML
  description lists to explain what each field does, in this format:
  
  https://review.openstack.org/#/c/348969/5/openstack_dashboard/static/app/core/networks/actions
  /subnet-details.help.html
  
  This information can just be pulled from the API docs
  
  Note, to enable the angular images panel at this point in time, you will
  need to override the default ANGULAR_FEATURES setting. An example of
  overriding this setting is here:
  https://review.openstack.org/#/c/357041/ In this instance, you will want
  to change the setting to True instead of False.
+ 
+ You may also want to base this change on
+ https://review.openstack.org/#/c/356501/ as it affects the create volume
+ help file.

-- 
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/1615687

Title:
  Help text in Angular Images workflows is lacking

Status in OpenStack Dashboard (Horizon):
  New

Bug description:
  The help text in the following angular workflows is very sparse:

  - Create Image
  - Edit Image
  - Create Volume

  These files can be found at
  openstack_dashboard/static/app/core/images/steps/create-
  image/*/*.help.html

  We should drop the unnecessary 'Description' header and just use HTML
  description lists to explain what each field does, in this format:

  https://review.openstack.org/#/c/348969/5/openstack_dashboard/static/app/core/networks/actions
  /subnet-details.help.html

  This information can just be pulled from the API docs

  Note, to enable the angular images panel at this point in time, you
  will need to override the default ANGULAR_FEATURES setting. An example
  of overriding this setting is here:
  https://review.openstack.org/#/c/357041/ In this instance, you will
  want to change the setting to True instead of False.

  You may also want to base this change on
  https://review.openstack.org/#/c/356501/ as it affects the create
  volume help file.

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


Follow ups