Project

General

Profile

action #153475

Updated by okurz 7 months ago

## Motivation 
 From the SUSE QE Tools coordination call when we had a demonstration about #152569 we realized that a string like `[Not restarting because job has been restarted already $auto_clone_limit times and failed with /$auto_clone_regex/]` is confusing because of the dollar signs. And it doesn't reveal the values so it's not obvious what the number or the regex is. 
 For reference the "already cloned n times" message does state say the maximum. 

 ## Acceptance criteria 
 * **AC1:** The user facing informational messages avoids dollar-signs as those are implementation-specifics 
 * **AC2:** The messages still state explicitly that those values can be configured somehow 

 ## Suggestions 
 * Consider using explicit wording like "variables" or "settings" (or ALL_CAPS) ALL_CAPS and/or reference the actual values 
 * Consider prefixing the config section, e.g. "global:auto_clone_regex" or "global.auto_clone_regex" 
 * Add a help icon or URL to the point where the actual value is defined 
 * Expand the values, either within the reason or somewhere else like in a comment, the investigation tab or elsewhere 
 * Clarify limitations of the reason, and if they can be addressed

Back