Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add "Running your first test plan" tutorial #705

Merged
merged 7 commits into from
Sep 8, 2023
Merged

Add "Running your first test plan" tutorial #705

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
24f166c
Add "Running first test plan" tutorial section
pieqq Sep 5, 2023
2da47f4
Modify resource job unit documentation page
pieqq Sep 6, 2023
539a952
Modify documentation glossary (test plan, job and resrouce sections)
pieqq Sep 6, 2023
5f195d9
Add Wrapping up section in the "Running" tutorial
pieqq Sep 6, 2023
5129ef0
Adding headers to the Running test plan tutorial
pieqq Sep 8, 2023
171502b
Fixes based on feedback
pieqq Sep 8, 2023
94df370
Fix typo
pieqq Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions docs/reference/glossary.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading