Skip to content

Commit

Permalink
Add Checkbox commands tutorial (#635)
Browse files Browse the repository at this point in the history
* Add Checkbox commands tutorial

Fix CHECKBOX-766

* Remove "Using Checkbox" how-to

This document is not necessary anymore since we have a dedicated
tutorial that covers all of these sections now.

* Add more info about bootstrapping in glossary and link to resource unit

* Feedback from Max

* Fixup tings after removing using.rst

After removing using.rst, a reference to the `run` subcommand was broken
in the "Understanding Checkbox". The ref now points to the tutorial.

Also removing reference to `using` in the index page since it no longer
exists.
  • Loading branch information
pieqq committed Aug 8, 2023
1 parent a545e32 commit a3b27cb
Show file tree
Hide file tree
Showing 7 changed files with 312 additions and 270 deletions.
Binary file removed docs/_images/cc2.png
Binary file not shown.
Binary file removed docs/_images/cc3.png
Binary file not shown.
1 change: 0 additions & 1 deletion docs/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ These how-to guides cover key operations and processes in Checkbox.
.. toctree::
:maxdepth: 1

using
testing-ubuntu-core
custom-app
nested-test-plan
Expand Down
267 changes: 0 additions & 267 deletions docs/how-to/using.rst

This file was deleted.

5 changes: 3 additions & 2 deletions docs/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ Glossary

Bootstrapping

Phase of a Checkbox session where resource jobs are executed to gather
information about the hardware.
Phase of a Checkbox session where :ref:`resource jobs<resource>` are
executed to gather information about the hardware and :ref:`template
jobs<templates>` are instantiated based on said hardware.

Requirement program

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/units/resource.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _resource:

==================
Resource Job Units
==================
Expand Down

0 comments on commit a3b27cb

Please sign in to comment.