Project

General

Profile

Actions
Copy link

action #153574

open

coordination #154768: [saga][ux] State-of-art user experience for openQA

[epic] UML and doxygen-like design documentation for os-autoinst

Added by okurz 4 months ago. Updated about 1 month ago.

Status:
New
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
QA - future
Start date:
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)

Description

Motivation

For long-term sustainability of os-autoinst and to get newcomers moving os-autoinst should have proper design documents.

Acceptance criteria

  • AC1: design documents are reachable from the main README

Suggestions

  • Look into mermaid on GitHub or plantuml or umbrello and generate some documents for os-autoinst
  • Research doxygen for Perl or alternatives

Subtasks

Actions
Copy link
 #1

Updated by okurz 2 months ago

  • Target version changed from Tools - Next to future
Actions
Copy link
 #2

Updated by okurz about 2 months ago

  • Subtask #157360 added
Actions
Copy link
 #3

Updated by okurz about 2 months ago

  • Parent task set to #154768
Actions
Copy link
 #5

Updated by okurz about 1 month ago

ok, that looks like a promising start. Some documentation shows up, e.g. in https://w3.nue.suse.com/~timueller/doxygen/os-autoinst/classtestapi.html but not related to the functions or methods itself. Same for openQA, e.g. https://w3.nue.suse.com/~timueller/doxygen/openQA/classOpenQA_1_1Schema_1_1Result_1_1Jobs.html#af189c88829b46510aa4f22d58598cb29 shows no documentation for "can_be_duplicated". Is that something we can fix?

Actions
Copy link

Also available in: Atom PDF