Skip to content

Commit 895b477

Browse files
krystian-hebelBeataZdunczyk
authored andcommitted
user-docs/openqa.md: add user-cancelled jobs, elaborate on some details
Signed-off-by: Krystian Hebel <krystian.hebel@3mdeb.com>
1 parent acddd4d commit 895b477

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/user-docs/openqa.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ there.
6262
### Product
6363

6464
A _Product_ represents one run of a set of test suites with given parameters.
65-
The name of the products consists of a couple parts
66-
It consists of:
65+
The name of each product consists of the following parts:
6766

6867
- The name of the tested OS distribution - to run tests on every maintained
6968
distribution
@@ -98,9 +97,10 @@ _Test Suites_ are the essence of the OpenQA web panel. Next to every test suite
9897
you can see a small colorful circle informing about the status of the
9998
_Test Suite_. The most common statuses are:
10099

101-
- Gray - Skipped
100+
- Gray - Skipped or Canceled (can be disambiguated via a tooltip text)
102101
+ The test was decided to not be performed based on the results of
103102
other tests, like its dependencies failing
103+
+ The test was canceled by the user before finishing
104104
- Green - Pass
105105
+ The test passed without any issues
106106
- Red - Fail
@@ -126,7 +126,7 @@ a couple tabs with more details.
126126

127127
#### Details Tab
128128

129-
The default tab shown when selecting a _Test Suite_ is its
129+
The default tab shown when selecting a finished _Test Suite_ is its
130130
_Details_ tab. It contains a summary of all of the _Tests_ being a part of
131131
the _Test Suite_ and their statuses.
132132

@@ -161,8 +161,8 @@ content created during the _Test Suite_. This includes:
161161

162162
- `Video` - A video recording of the screen for the whole duration of the _Test Suite_
163163
- `autoinst-log.txt` - Logs from the test
164-
- `worker-log.txt` - Logs created by the OpenQA worker process running
165-
on the tested device
164+
- `worker-log.txt` - Logs created by the OpenQA worker process managing
165+
the tested device
166166
- `vars.json` - A JSON file containing all of the configuration variables
167167
used to control the execution of the _Test Suite_
168168
- `serial0.txt` - The serial port output from the tested device

0 commit comments

Comments
 (0)