.. hotsos documentation master file, created by
   sphinx-quickstart on Mon Jun 19 09:55:40 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


=================
Contributor Guide
=================

All the information you need to start contributing to Hotsos.

Language Reference
------------------

Hotsos has its own YAML-based language used to write analysis. Using `propertree <https://github.com/dosaboy/propertree>`_
mappings it provides a library of properties that can be used to implement analysis.

.. toctree::
   :maxdepth: 2

   language_ref/index


Writing Checks
--------------

.. toctree::
   :maxdepth: 2

   writing_checks_overview

Scenarios
---------

.. toctree::
   :maxdepth: 2

   scenarios

Events
------

.. toctree::
   :maxdepth: 2

   events

Testing
-------

.. toctree::
   :maxdepth: 2

   testing