Project

General

Profile

action #105001

QA - coordination #91646: [saga][epic] SUSE Maintenance QA workflows with fully automated testing, approval and release

coordination #89062: [epic] Simplify review for SUSE QAM

coordination #93246: [epic] List all unreviewed failed (or incomplete) jobs on /tests on request size:M

Add doc for "todo" query parameter on /tests, similar to /tests/overview size:S

Added by okurz 4 months ago. Updated 4 months ago.

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

0%

Estimated time:
Difficulty:
Tags:

Description

Motivation

As a test reviewer and member of one of many QA squads I want to find unreviewed openQA test failures on /tests to have access to a single page showing all recent failures needing review work. With #103765 the todo parameter already works on /tests but users need to know about it so make sure the parameter is described in documentation.

Also see parent #93246

Acceptance criteria

  • AC1: The query parameter "todo=1" on /tests is explained in documentation

Suggestions

  • Research how the query parameter for todo on /tests/overview is referenced in documentation and do the same for /tests
  • Look at the PR https://github.com/os-autoinst/openQA/pull/4450 which implemented it
  • Test with different parameters and confirm how it's used by end users

Related issues

Copied from openQA Project - action #104995: Add UI element and help text for "todo" query parameter on /tests, similar as /tests/overviewResolved

History

#1 Updated by okurz 4 months ago

  • Copied from action #104995: Add UI element and help text for "todo" query parameter on /tests, similar as /tests/overview added

#2 Updated by mkittler 4 months ago

  • Assignee set to mkittler

Research how the query parameter for todo on /tests/overview is referenced in documentation and do the same for /tests

Unless I'm missing something it is not referenced at all. The only documentation is the help-popover which I've already added as part of #104995. I'm also wondering whether it makes sense to add extra documentation for the flag since the help popover should be sufficient considering the checkbox is placed where users should be able to discover it on their own.

#3 Updated by okurz 4 months ago

mkittler wrote:

Unless I'm missing something it is not referenced at all. The only documentation is the help-popover which I've already added as part of #104995.

Not exactly true because there is http://open.qa/docs/#_filtering_test_results_and_builds but that's far below what I expected would be there already.

I'm also wondering whether it makes sense to add extra documentation for the flag since the help popover should be sufficient considering the checkbox is placed where users should be able to discover it on their own.

Well, I agree that having a help in UI is often better and likely reaches more people than documentation. However I think describing certain workflows in the documentation can still be beneficial. But you can also consider extending the UI help text. Because right now it also just says something like "fix all these todo jobs to get a black badge", not what that actually means.

If you find all that unclear feel free to unassign again. I might find the time to think of what I want to see and put it there myself :D

#4 Updated by okurz 4 months ago

  • Subject changed from Add doc for "todo" query parameter on /tests, similar as /tests/overview size:M to Add doc for "todo" query parameter on /tests, similar as /tests/overview

#5 Updated by mkittler 4 months ago

  • Assignee deleted (mkittler)

#6 Updated by cdywan 4 months ago

We should estimate it first, but maybe a nice one for kodymo since it's a good excuse to learn about our API and see if it makes sense to someone less experienced

#7 Updated by cdywan 4 months ago

  • Subject changed from Add doc for "todo" query parameter on /tests, similar as /tests/overview to Add doc for "todo" query parameter on /tests, similar to /tests/overview size:S
  • Description updated (diff)
  • Status changed from New to Workable

#8 Updated by kodymo 4 months ago

  • Status changed from Workable to In Progress
  • Assignee set to kodymo

#9 Updated by kodymo 4 months ago

PR: https://github.com/os-autoinst/openQA/pull/4469

The PR is merged now, Feedback on this?

#10 Updated by kodymo 4 months ago

  • Status changed from In Progress to Feedback

#11 Updated by kodymo 4 months ago

  • Status changed from Feedback to Resolved

Also available in: Atom PDF