Skip to content

Commit

Permalink
docs: Replace dated styling/Mark systemctl command
Browse files Browse the repository at this point in the history
  • Loading branch information
Frogrhino committed Feb 20, 2020
1 parent 4230422 commit 9396e72
Show file tree
Hide file tree
Showing 9 changed files with 449 additions and 443 deletions.
10 changes: 5 additions & 5 deletions docs/Branding.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

You can alter the appearance of the openQA web UI to some extent through
the 'branding' mechanism. The 'branding' configuration setting in the
'global' section of +/etc/openqa/openqa.ini+ specifies the branding to
'global' section of `/etc/openqa/openqa.ini` specifies the branding to
use. It defaults to 'openSUSE', and openQA also includes the 'plain'
branding, which is - as its name suggests - plain and generic.

To create your own branding for openQA, you can create a subdirectory
of +/usr/share/openqa/templates/branding+ (or wherever openQA is
of `/usr/share/openqa/templates/branding` (or wherever openQA is
installed). The subdirectory's name will be the name of your branding.
You can copy the files from +branding/openSUSE+ or +branding/plain+ to
You can copy the files from `branding/openSUSE` or `branding/plain` to
use as starting points, and adjust as necessary.

== Web UI template
Expand All @@ -26,8 +26,8 @@ use as starting points, and adjust as necessary.
openQA uses the {mojo-website} framework's templating
system; the branding files are included into the openQA templates at
various points. To see where each branding file is actually included,
you can search through the files in the +templates+ tree for the text
+include_branding+. Anywhere that helper is called, the branding file
you can search through the files in the `templates` tree for the text
`include_branding`. Anywhere that helper is called, the branding file
with the matching name is being included.

The branding files themselves are Mojolicious 'Embedded Perl' templates just
Expand Down
130 changes: 65 additions & 65 deletions docs/Contributing.asciidoc

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/ExternalResults.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ be easily extended to include more formats, such as RSpec or TAP.
The requirements to use this functionality, are quite simple:

* The test harness must produce a compatible format with supported {parser-format}.
* The test results can be uploaded via +testapi::parse_extra_log+ within an openQA tests.
* The test results can be uploaded via `testapi::parse_extra_log` within an openQA tests.
* The test results can also be uploaded via web {api-endpoint}.

openQA will store these results in its own internal format for easier presentation,
Expand All @@ -31,12 +31,12 @@ but still will allow the original file to be downloaded.
== Usage

If a test developer wishes to use the functional interface, after finishing the
execution of the the testing too, calling +testapi::parse_extra_log+ with the
execution of the the testing too, calling `testapi::parse_extra_log` with the
location to a the file generated.

=== openQA test distribution

From within a common openQA test distribution, a developer can use +parse_extra_log+
From within a common openQA test distribution, a developer can use `parse_extra_log`
to upload a text file that contains a supported test output:

[source,perl]
Expand Down Expand Up @@ -70,12 +70,12 @@ test results, test definition and test output.
=== Structured data

In structured data mode, elements of the collections are objects. They can be
of any type, even though subclassing or objects of type of +OpenQA::Parser::Result+
of any type, even though subclassing or objects of type of `OpenQA::Parser::Result`
are prefered.

One thing to keep in mind, is that in case deeply nested objects need to be parsed
like hash of hashes, array of hashes, they would need to subclass +OpenQA::Parser::Result+
or +OpenQA::Parser::Results+ respectively.
like hash of hashes, array of hashes, they would need to subclass `OpenQA::Parser::Result`
or `OpenQA::Parser::Results` respectively.

As an example, JUnit format can be parsed this way:

Expand Down
30 changes: 15 additions & 15 deletions docs/GettingStarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ arch:: an architecture variant of a _product_, e.g. "x86_64"
machine:: additional variant of machine, e.g. used for "64bit", "uefi", etc.

scenario:: A composition of
+<distri>-<version>-<flavor>-<arch>-<test_suite>@<machine>+, e.g.
`<distri>-<version>-<flavor>-<arch>-<test_suite>@<machine>`, e.g.
"openSUSE-Tumbleweed-DVD-x86_64-gnome@64bit", nicknamed _koala_

build:: Different versions of a product as tested, can be considered a
Expand Down Expand Up @@ -167,9 +167,9 @@ overall result from the following list.
point.
* *softfailed* At least one known, non-critical issue has been found. That could be
that workaround needles are in place, a softfailure has been recorded explicitly
via +record_soft_failure+ (from os-autoinst) or a job failure has been ignored
via `record_soft_failure` (from os-autoinst) or a job failure has been ignored
explicitly via a <<UsersGuide.asciidoc#_show_bug_or_label_icon_on_overview_if_labeled_gh550,job label>>.
* *timeout_exceeded* The job was aborted because +MAX_JOB_TIME+ was exceeded, which is
* *timeout_exceeded* The job was aborted because `MAX_JOB_TIME` was exceeded, which is
by default two hours.
* *skipped* Dependencies failed so the job was not started.
* *obsoleted* The job was superseded by scheduling a new product.
Expand Down Expand Up @@ -283,8 +283,8 @@ blog post] about the subject by the openQA development team.
=== Job groups

A job can belong to a job group. Those job groups are displayed on the index
page when there are recent test results in these job groups and in the +Job
Groups+ menu on the navigation bar. From there the job group overview pages
page when there are recent test results in these job groups and in the `Job
Groups` menu on the navigation bar. From there the job group overview pages
can be accessed. Besides the test results the job group overview pages provide
a description about the job group and allow commenting.

Expand All @@ -299,7 +299,7 @@ the index page.

=== Cleanup
IMPORTANT: openQA automatically deletes data that it considers "old" based on
different settings. For example job data is deleted from old jobs by the +gru+ task.
different settings. For example job data is deleted from old jobs by the `gru` task.

The following cleanup settings can be done on job-group-level:

Expand Down Expand Up @@ -327,13 +327,13 @@ the mentioned cleanup properties.
== Using the client script
:openqa-personal-configuration: ~/.config/openqa/client.conf

Just as the worker uses an API key+secret every user of the +client script+
Just as the worker uses an API key+secret every user of the `client script`
must do the same. The same API key+secret as previously created can be used or
a new one created over the webUI.

The personal configuration should be stored in a file
`{openqa-personal-configuration}` in the same format as previously described for
the +client.conf+, i.e. sections for each machine, e.g. `localhost`.
the `client.conf`, i.e. sections for each machine, e.g. `localhost`.

[[get-testing]]
== Testing openSUSE or Fedora
Expand All @@ -348,7 +348,7 @@ this document should help you to get started faster.
First you need to get actual tests. You can get openSUSE tests and needles (the
expected results) from
https://github.com/os-autoinst/os-autoinst-distri-opensuse[GitHub]. It belongs
into the +/var/lib/openqa/tests/opensuse+ directory. To make it easier, you can just
into the `/var/lib/openqa/tests/opensuse` directory. To make it easier, you can just
run

[source,sh]
Expand Down Expand Up @@ -387,8 +387,8 @@ following command:

This will load some default settings that were used at some point of time in
openSUSE production openQA. Therefore those should work reasonably well with
openSUSE tests and needles. This script uses +/usr/share/openqa/script/load_templates+,
consider reading its help page (+--help+) for documentation on possible extra arguments.
openSUSE tests and needles. This script uses `/usr/share/openqa/script/load_templates`,
consider reading its help page (`--help`) for documentation on possible extra arguments.

For Fedora, similarly, you can call:

Expand All @@ -398,14 +398,14 @@ For Fedora, similarly, you can call:
--------------------------------------------------------------------------------

Some Fedora tests require special hard disk images to be present in
+/var/lib/openqa/share/factory/hdd/fixed+. The +createhdds.py+ script in the
`/var/lib/openqa/share/factory/hdd/fixed`. The `createhdds.py` script in the
https://pagure.io/fedora-qa/createhdds[createhdds]
repository can be used to create these. See the documentation in that repo
for more information.

=== Adding a new ISO to test

To start testing a new ISO put it in +/var/lib/openqa/share/factory/iso+ and call
To start testing a new ISO put it in `/var/lib/openqa/share/factory/iso` and call
the following commands:

[source,sh]
Expand All @@ -421,10 +421,10 @@ openqa-client isos post \
--------------------------------------------------------------------------------

If your openQA is not running on port 80 on 'localhost', you can add option
+--host=http://otherhost:9526+ to specify a different port or host.
`--host=http://otherhost:9526` to specify a different port or host.

WARNING: Use only the ISO filename in the 'client' command. You must place the
file in +/var/lib/openqa/share/factory/iso+. You cannot place the file elsewhere and
file in `/var/lib/openqa/share/factory/iso`. You cannot place the file elsewhere and
specify its path in the command. However, openQA also supports a
remote-download feature of assets from trusted domains.

Expand Down
Loading

0 comments on commit 9396e72

Please sign in to comment.