:relatedlinks: [Diátaxis](https://diataxis.fr/)

.. _home:

Checkbox
========

Checkbox is a testing framework used to validate device compatibility with
Ubuntu Linux.

It runs test plans made of test cases (or jobs) and generates test reports.
Jobs can be manual or automated. Any Linux command can be turned into a job.

Checkbox was developed as part of the `Ubuntu Certified`_ program. It runs
tests that ensure all the required features of a given device are working as
expected on Ubuntu Linux. It is compatible with any version of Ubuntu (Desktop,
Server, Core).

Checkbox is useful for anyone who wants to make sure their devices are running
as expected on Ubuntu.

---------

In this documentation
---------------------

..  grid:: 1 1 2 2

   ..  grid-item:: :doc:`Tutorial <tutorial/index>`

       **Start here**: a hands-on introduction to Checkbox for new users

   ..  grid-item:: :doc:`How-to guides <how-to/index>`

      **Step-by-step guides** covering key operations and common tasks

.. grid:: 1 1 2 2
   :reverse:

   .. grid-item:: :doc:`Reference <reference/index>`

      **Technical information** - specifications, APIs, architecture

   .. grid-item:: :doc:`Explanation <explanation/index>`

      **Discussion and clarification** of key topics

---------

Project and community
---------------------

Checkbox is a member of the Ubuntu family. It’s an open source project that
warmly welcomes community projects, contributions, suggestions, fixes and
constructive feedback.

* This project follows the `Ubuntu Code of Conduct`_
* :doc:`Get support <community/support>`
* :doc:`Report bugs <community/bugs>`
* :doc:`Contribute <community/contributing>`


.. toctree::
   :hidden:
   :maxdepth: 2

   tutorial/index
   how-to/index
   reference/index
   explanation/index

.. _Ubuntu Certified: https://ubuntu.com/certified
.. _Ubuntu Code of Conduct: https://ubuntu.com/community/ethos/code-of-conduct