QA (public) » openQA Project (public)

Motivation¶

During the team effort on fixing and retriggering multiple jobs, I found interesting that there are automations in the scripts repo but most of us were hesitatant to utilize. Are they intuitive enough? Can we improve there somehow? Was something missing from the script functionality? Side effects? Maybe we need to improve the documentation?

Acceptance Criteria¶

• AC1: All scripts have at least a short --help text stating the purpose and basic usage and requirements
• AC2: The most important scripts are hightlighted in the README (as the whole number of scripts is quite high at this point)

Suggestions¶

• Add concrete examples to scripts showing how they are used
• Add help texts to scripts
• Implement proper command-line arguments
• Add a general README that explains in which situation to use which script (and when not to use them) with example calls.