Skip to content

Commit acddd4d

Browse files
krystian-hebelBeataZdunczyk
authored andcommitted
user-docs/openqa.md: syntax fixes for mkdocs
Signed-off-by: Krystian Hebel <krystian.hebel@3mdeb.com>
1 parent 1ea4569 commit acddd4d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/user-docs/openqa.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ The results of TrenchBoot automated tests can be viewed on
1313

1414
The website allows anyone to freely monitor all the details about the tests run,
1515
including:
16+
1617
- configuration variables
1718
- collected logs
1819
- screenshots and a video recording of the screen for the duration of a test
1920
- the results and the reasons behind fails
2021

2122
Anyone can login to the website via GitHub, but only the authorized
2223
accounts are able to:
24+
2325
- run the tests
2426
- create new tests
2527
- modify any settings
@@ -62,6 +64,7 @@ there.
6264
A _Product_ represents one run of a set of test suites with given parameters.
6365
The name of the products consists of a couple parts
6466
It consists of:
67+
6568
- The name of the tested OS distribution - to run tests on every maintained
6669
distribution
6770
- The version - to allow running the tests on every new release
@@ -73,6 +76,7 @@ not only run a single test per hardware architecture. For this reason the
7376
_Flavor_ field of a _Product_ is used a bit unconventionally. At this moment
7477
TrenchBoot does not consist of multiple _Flavors_ and the field is used to
7578
determine:
79+
7680
- on which hardware platform the tests were performed
7781
- whether it was installed on a Legacy or an UEFI BIOS
7882

@@ -93,6 +97,7 @@ with it.
9397
_Test Suites_ are the essence of the OpenQA web panel. Next to every test suite
9498
you can see a small colorful circle informing about the status of the
9599
_Test Suite_. The most common statuses are:
100+
96101
- Gray - Skipped
97102
+ The test was decided to not be performed based on the results of
98103
other tests, like its dependencies failing
@@ -129,6 +134,7 @@ Every single test consists of one or more _Asserts_, which
129134
are used to determine whether the test _Passes_ or _Fails_.
130135
The _Details_ page shows the proofs for every _Assert_ during
131136
a test. The proofs are:
137+
132138
- screenshots, which are being asserted
133139
by comparing selected parts of the screen to the expected outcomes
134140
- text logs, compared to expected outputs
@@ -152,6 +158,7 @@ clicking on the corresponding box in any _Test Suite_.
152158

153159
The _Logs & Assets_ tab contains all of the downloadable
154160
content created during the _Test Suite_. This includes:
161+
155162
- `Video` - A video recording of the screen for the whole duration of the _Test Suite_
156163
- `autoinst-log.txt` - Logs from the test
157164
- `worker-log.txt` - Logs created by the OpenQA worker process running
@@ -198,7 +205,8 @@ in the exact suite it might not contain any useful information.
198205
|:-:|
199206
|The Comments tab|
200207

201-
A test containing comments is marked with a blue speech bubble
208+
A test containing comments is marked with a blue speech bubble:
209+
202210
|![Test with comment](../img/openqa/test-with-comment.png)|
203211
|:-:|
204212
|A test containing comments|

0 commit comments

Comments
 (0)