.. _contents_top:

Contents
########

The LAVA documentation is continually expanding and improving. This is the
overview to help you know where to look for particular help.

=======================================================================

* :ref:`contents_first_steps_using` - if you are a new user of LAVA V2
  and looking to submit tests an an existing instance, start here.

* :ref:`contents_first_steps_installing` - if you are starting with a
  fresh installation or running your own instance, start here.

* :ref:`getting_support`

========================================================================

* :ref:`contents_lava_ci` - this section explains the design goals
  of LAVA and how to use it best as part of a complete CI system.

* :ref:`contents_writing_tests` - this guide takes you through how to
  design, write and debug the tests to be run using LAVA. Worked
  examples are included for a range of deployments and test methods.

* :ref:`contents_results` - LAVA provides a generic view of test
  results. This guide covers how to use those results directly, and
  also how to export results data from LAVA to make it more useful.

========================================================================

* :ref:`contents_admin_guide` - this guide steps through the complex
  task of administering a LAVA instance, from a single emulated device
  to a large test lab with dozens of devices.

* :ref:`contents_migration` - documentation to help users migrating a
  lab and its devices from LAVA V1 to V2.

========================================================================

* :ref:`contents_contribution_guide` - LAVA is developed in the open, and
  contributions are welcome from the community. This guide introduces
  the code structure and design requirements as well as how to
  contribute patches for review.

* :ref:`contents_integration_guide` - the most complex part of LAVA is
  integrating a new :term:`device type`. You should already have a local LAVA
  instance which has successfully run a large number of tests on more than one
  :ref:`known device-type <standard_known_devices>`.

========================================================================

* :ref:`contents_context_help` - some pages in the UI have a ``Help``
  link in the context-menu section at the top of the page. These pages
  are listed in this section for reference and easier navigation.

* :ref:`glossary` - descriptions of terms which have particular meanings inside
  LAVA.

========================================================================

.. toctree::
   :maxdepth: 1
   :hidden:

   glossary
   support
   self

.. _contents_first_steps_using:

First steps using LAVA
======================

.. toctree::
   :maxdepth: 1

   first_steps
   first-job
   explain_first_job
   lavacli
   gold-standards
   standard-test-jobs
   standard-qemu-stretch
   standard-qemu-kernel
   standard-armmp-ramdisk-bbb

.. _contents_first_steps_installing:

First steps installing LAVA
===========================

.. toctree::
   :maxdepth: 1

   first-installation
   installing_on_debian
   authentication
   first-devices

.. _contents_lava_ci:

CI with LAVA
============

.. toctree::
   :maxdepth: 1

   lava_ci

.. _contents_writing_tests:

Writing tests for LAVA
======================

.. toctree::
   :maxdepth: 1

   developing-tests
   timeouts
   writing-tests
   test-repositories
   lava_test_shell
   publishing-artifacts
   monitors
   interactive
   healthchecks
   hacking-session
   qemu_options
   secondary-media
   connections
   dispatcher-actions
   multinode
   writing-multinode
   multinodeapi
   debugging
   pipeline-usecases
   templating

.. _contents_results:

Results in LAVA
===============

.. toctree::
   :maxdepth: 1

   results-intro
   lava-queries-charts
   data-export
   user-notifications
   custom-result-handling
   relating
   tables
   favorite-jobs

.. _contents_admin_guide:

LAVA administration guide
=========================

.. toctree::
   :maxdepth: 1

   simple-admin
   authorization
   admin-backups
   advanced-installation
   admin-secondary-media
   growing_your_lab
   pipeline-server
   pipeline-admin
   devicetypes
   device-capabilities
   hiddentypes
   bootimages
   pdudaemon
   ipmi-pxe-deploy
   ipxe
   proxy
   pipeline-debug
   docker-admin
   fvp
   avh

.. _contents_contribution_guide:

LAVA Software Community Project Contribution Guide
==================================================

.. toctree::
   :maxdepth: 1

   code-of-conduct
   contribution-intro
   contribution
   naming-conventions
   review-criteria
   development-intro
   process
   development
   pipeline-design
   dispatcher-design
   dispatcher-format
   pipeline-schema
   dispatcher-testing
   debian
   packaging
   developer-example
   scheduler
   functional_tests

.. _contents_integration_guide:

LAVA device integration guide
=============================

.. toctree::
   :maxdepth: 1

   device-integration
   integrate-uboot
   integrate-fastboot
   integrate-iot
   integrate-uefi
   integration-stories
   bootloaders

.. _contents_migration:

Migrating to V2
===============

.. toctree::
   :maxdepth: 1

   pipeline-writer
   migrating-admin-example

.. _contents_context_help:

Context help
============

.. toctree::
   :maxdepth: 1

   other
