As requested by @nadjaheitmann I'll repost this from this foreman community thread:
Right now, understanding what it does and how to interpret the current texts in the context (as simple user of puppet and no expert fluent with the puppet terminology) I think the first misleading thing about the page editing the class parameters is the placement of the override checkbox. Currently it’s in the “Default Behavior” section:
Default Behavior
Override the default value of the Puppet class parameter.
Override x
Now the override isn’t overriding the default behavior nor the default value of the parameter, but it’s the main switch to tell foreman to manage the parameter, providing values to puppet or not.
Thus, move the Override checkbox above the default section and make it big and clear that this checkbox enables the override for this parameter and thus all the information below is only relevant if that checkbox is checked.
Second rename “Default Behavior” to “Default Value”. It’s no behavior, you’ll define a value.
Move the “omit” checkbox to the first position in this section (i.e. move it to the place where currently the override checkbox is). Rename the omit checkbox to something like “Override default value” and the “i” tooltip to something like “Use this value instead of the puppet parameter default or class hiera data”.
I think I would immediately understand the meaning of those controls then and it’s more the expected order from the top to the bottom instead now with the omit checkbox disabling the default value textbox above.
As requested by @nadjaheitmann I'll repost this from this foreman community thread:
Right now, understanding what it does and how to interpret the current texts in the context (as simple user of puppet and no expert fluent with the puppet terminology) I think the first misleading thing about the page editing the class parameters is the placement of the override checkbox. Currently it’s in the “Default Behavior” section:
Now the override isn’t overriding the default behavior nor the default value of the parameter, but it’s the main switch to tell foreman to manage the parameter, providing values to puppet or not.
Thus, move the Override checkbox above the default section and make it big and clear that this checkbox enables the override for this parameter and thus all the information below is only relevant if that checkbox is checked.
Second rename “Default Behavior” to “Default Value”. It’s no behavior, you’ll define a value.
Move the “omit” checkbox to the first position in this section (i.e. move it to the place where currently the override checkbox is). Rename the omit checkbox to something like “Override default value” and the “i” tooltip to something like “Use this value instead of the puppet parameter default or class hiera data”.
I think I would immediately understand the meaning of those controls then and it’s more the expected order from the top to the bottom instead now with the omit checkbox disabling the default value textbox above.