Bug 1265085 - RFE: Add a "writing your first job" getting started guide
RFE: Add a "writing your first job" getting started guide
Status: NEW
Product: Beaker
Classification: Community
Component: Doc (Show other bugs)
Unspecified Unspecified
unspecified Severity unspecified (vote)
: ---
: ---
Assigned To: beaker-dev-list
: FutureFeature
Depends On:
  Show dependency treegraph
Reported: 2015-09-22 01:57 EDT by Nick Coghlan
Modified: 2018-02-05 20:03 EST (History)
4 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Nick Coghlan 2015-09-22 01:57:33 EDT
This RFE suggests adding an end user focused getting started guide to the docs that shows (given an existing Beaker installation) how to write and submit:

1. A single task recipe that runs /distribution/command as an example of how to write and submit jobs, and query the results.
2. As above, but running a test from git rather than the task library

A guide like this could serve as a destination page for a "New to Beaker? Start here!" link on the docs page and the front page, linking out to other more detailed reference documentation as appropriate.

This should hopefully not only make it easier to get started, but also means that folks landing at https://beaker-project.org/docs/ for the first time are more likely to be able to gain a clear idea of what Beaker can do for them.

Without an appreciation of that core integration testing capability to provide context, wider capability descriptions like https://beaker-project.org/docs/architecture-guide/capabilities.html, or documentation of specific features like the connection between predefined host filters (https://beaker-project.org/docs/man/bkr.html#cmdoption-bkr--host-filter) and the hardware inventory system (https://beaker-project.org/docs/man/bkr-update-inventory.html) is more likely to be overwhelming than it is helpful.

Note You need to log in before you can comment on or make changes to this bug.