Project

General

Profile

Actions

action #153475

closed

coordination #154768: [saga][ux] State-of-art user experience for openQA

coordination #157345: [epic] Improved test reviewer user experience

Reconsider the formatting of variable-names in the reason field, e.g. "$auto_clone_regex" size:S

Added by okurz 3 months ago. Updated 9 days ago.

Status:
Resolved
Priority:
Low
Assignee:
Category:
Feature requests
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:

Description

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 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) 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

Related issues 1 (0 open1 closed)

Copied from openQA Project - action #152569: Many incomplete jobs endlessly restarted over several weeks size:MResolvedtinita2023-12-132024-01-12

Actions
Actions #1

Updated by okurz 3 months ago

  • Copied from action #152569: Many incomplete jobs endlessly restarted over several weeks size:M added
Actions #2

Updated by livdywan 3 months ago

  • Description updated (diff)
Actions #3

Updated by okurz about 1 month ago

  • Target version changed from Tools - Next to Ready
Actions #4

Updated by okurz about 1 month ago

  • Subject changed from Reconsider the formatting of variable-names in the reason field, e.g. "$auto_clone_regex" to Reconsider the formatting of variable-names in the reason field, e.g. "$auto_clone_regex" size:S
  • Description updated (diff)
  • Status changed from New to Workable
Actions #5

Updated by okurz about 1 month ago

  • Priority changed from Normal to Low
Actions #6

Updated by okurz 24 days ago

  • Parent task set to #157345
Actions #7

Updated by mkittler 10 days ago

  • Status changed from Workable to In Progress
  • Assignee set to mkittler
Actions #8

Updated by mkittler 10 days ago

  • Status changed from In Progress to Feedback
Actions #9

Updated by mkittler 9 days ago

  • Status changed from Feedback to Resolved

The PR has been merged, all ACs are covered by that.

Actions

Also available in: Atom PDF