Bug 980660

Summary: Clearly document beah task structure
Product: [Retired] Beaker Reporter: Nick Coghlan <ncoghlan>
Component: DocAssignee: beaker-dev-list
Status: CLOSED CURRENTRELEASE QA Contact: tools-bugs <tools-bugs>
Severity: unspecified Docs Contact:
Priority: low    
Version: 0.13CC: bpeck, jingwang, kbanerje, mastyk, qwan, tools-bugs
Target Milestone: ---Keywords: Documentation, EasyFix, Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: 980423 Environment:
Last Closed: 2020-02-26 06:45:06 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Nick Coghlan 2013-07-03 00:52:57 UTC
The new task docs in Beaker 0.13 are in improvement, but are still missing an overview of the required contents of a beah task. The example relies on beaker-wizard to generate the skeleton, while the task metadata section runs through some expected variables in the Makefile and testinfo.desc without actually summarising the expected files anywhere.

We need a "Structure of a beah task" section which:

1. Explains the required files
2. Explains the general concepts involved in result reporting and log uploading
3. Makes it clear that tasks are assumed to fail by default, *unless* a positive result is reported (and rhts-run-simple-command is an easier way to do that)

This section would reference other sections for details where appropriate.

+++ This bug was initially created as a clone of Bug #980423 +++