Jump to: navigation, search

Heat/UI/HelpText

< Heat‎ | UI
Revision as of 23:02, 27 November 2013 by Tim Schnell (talk | contribs) (Created page with "= Summary = Currently each parameter in the HOT syntax has a field called "description" that describes the purpose of the parameter. I am proposing an additional field called ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Summary

Currently each parameter in the HOT syntax has a field called "description" that describes the purpose of the parameter. I am proposing an additional field called "help" that can further explain a parameter.

Use Case

Description and help are separate things from a UI perspective. A description might be displayed as a label in a form or in a paragraph somewhere around the input. A help string is typically displayed as hover text when focusing on the input or hovering/clicking on a question mark icon next to the field. We could technically separate these things in the code but because they serve separate purposes I would prefer to have them be defined explicitly.

Example: An example where this use case originated was with Nova Keypairs. The description of a keypair parameter might be something like, "This is the name of a nova key pair that will be used to ssh to the compute instance." A help string for this same parameter would be, "To learn more about nova keypairs visit this help article: http://www.learnsomething.com/keypairs"

Specification

   Parameters:
       <parameter name>:

description: This is the name of a nova key pair that will be used to ssh to the compute instance. help: To learn more about nova key pairs visit this help article: http://www.learnsomething.com/keypairs