QA » openQA Project

https://progress.opensuse.org/issues/155491

Extend documentation for single-instance-container covering at least how to trigger/clone existing jobs size:S

Motivation¶

Based on a conversation we had regarding https://github.com/os-autoinst/openQA/pull/5472 and #155473 . There are some good ideas in the original proposal from mkittler and some comments what could be done to improve in https://github.com/os-autoinst/openQA/pull/5472#discussion_r1488683658

Acceptance criteria¶

• AC1: The openQA documentation presents easy examples how to trigger/clone existing jobs applicable to the single-instance-container

Suggestions¶

• Read the code commented in https://github.com/os-autoinst/openQA/pull/5472#discussion_r1488683658 and the according comments
• Extend the existing user guide showing some easy examples how to run an openQA client, e.g. from a client container, or – for experts – commands in the running instance of the container
• Optional: Rework GettingStarted.asciidoc to feature spawing the single-instance-container and using it to trigger/clone existing jobs
• Optional: After https://github.com/os-autoinst/openQA/blob/master/docs/Installing.asciidoc?plain=1#L68 add another section how to have a persistent database or asset management in openQA containers

Out of scope¶

• Any feature changes