Skip to content

Commit

Permalink
Add "Running your first test plan" tutorial section (#705)
Browse files Browse the repository at this point in the history
* Add "Running first test plan" tutorial section

* Modify resource job unit documentation page

* Modify documentation glossary (test plan, job and resrouce sections)

* Add Wrapping up section in the "Running" tutorial

* Adding headers to the Running test plan tutorial

* Fixes based on feedback

* Fix typo

Co-authored-by: tang-mm <tang.mmeng@gmail.com>

---------

Co-authored-by: tang-mm <tang.mmeng@gmail.com>
  • Loading branch information
pieqq and tang-mm committed Sep 8, 2023
1 parent 299f38c commit 87e0716
Show file tree
Hide file tree
Showing 3 changed files with 432 additions and 18 deletions.
27 changes: 14 additions & 13 deletions docs/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,18 @@ Glossary

Test plan

Test plans are text files used by Checkbox to select jobs for
execution. They can include simple regular expressions to match and
pick many similar jobs at once.
A :ref:`test plan<test-plan>` is a text file used by Checkbox to
select jobs for execution. They can include regular expressions to
match and pick many similar jobs at once.

Job

Jobs are smallest units of testing that can be performed by Checkbox.
All jobs have a unique name. There are many types of jobs, some are
fully automated others are fully manual. Some jobs are only an
implementation detail and a part of the internal architecture of
Checkbox.
A job is the smallest unit of testing that can be performed by
Checkbox. All jobs have a unique identifier. There are many types
of jobs, from the manual to the fully automated ones (see the
:ref:`job` reference page for more information). Some jobs such as
the :term:`resource` jobs are an implementation detail and
a part of the internal architecture of Checkbox.

Provider

Expand All @@ -71,12 +72,12 @@ Glossary
full identifier is composed of the namespace of a job provider and the
partial identifier, joined with the double-colon string ``::``.

Resources
Resource

Resources are collections of key-value data sets that are generated by
special resource jobs. They are extensively used to indicate hardware
or software dependencies. For example a bluetooth test may indicate it
requires bluetooth hardware and appropriate software packages
A resource is a collection of key-value data sets that are generated by
special :ref:`resource jobs<resource>`. They are extensively used to indicate hardware
or software dependencies. For example a Bluetooth test may indicate it
requires Bluetooth hardware and appropriate software packages
installed.

Bootstrapping
Expand Down
9 changes: 4 additions & 5 deletions docs/reference/units/resource.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _resource:

==================
Resource Job Units
==================
=================
Resource Job Unit
=================

Resources
=========
Expand All @@ -13,8 +13,7 @@ This mechanism allows some types of jobs to publish resource objects to an
abstract namespace and to a way to evaluate a resource program to determine if
a job can be started.

Resources also serve as a 'generator' for template units.
See :ref:`templates`
Resources also serve as a "generator" for :ref:`template units<templates>`.

Resource Jobs
-------------
Expand Down

0 comments on commit 87e0716

Please sign in to comment.