tempest/doc/source/index.rst

134 lines
2.0 KiB
ReStructuredText

=======================
Tempest Testing Project
=======================
Overview
========
.. toctree::
:maxdepth: 2
overview
Field Guides
============
Tempest contains tests of many different types, the field guides
attempt to explain these in a way that makes it easy to understand
where your test contributions should go.
.. toctree::
:maxdepth: 1
field_guide/index
field_guide/api
field_guide/scenario
field_guide/unit_tests
Users Guide
===========
Tempest Configuration Guide
---------------------------
.. toctree::
:maxdepth: 2
configuration
sampleconf
Command Documentation
---------------------
.. toctree::
:maxdepth: 1
account_generator
cleanup
subunit_describe_calls
workspace
run
Supported OpenStack Releases and Python Versions
------------------------------------------------
.. toctree::
:maxdepth: 1
supported_version
For Contributors
================
* If you are a new contributor to Tempest please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Developers Guide
================
Development
-----------
.. toctree::
:maxdepth: 2
HACKING
REVIEWING
microversion_testing
test_removal
write_tests
Plugins
-------
.. toctree::
:maxdepth: 2
plugin
plugin-registry
Tempest & Plugins Compatible Version Policy
-------------------------------------------
.. toctree::
:maxdepth: 2
tempest_and_plugins_compatible_version_policy
Stable Branch Testing Policy
----------------------------
.. toctree::
:maxdepth: 2
stable_branch_testing_policy
Library
-------
.. toctree::
:maxdepth: 2
library
Support Policy
--------------
.. toctree::
:maxdepth: 2
stable_branch_support_policy
Search
======
.. only:: html
* :ref:`Tempest document search <search>`: Search the contents of this document.
* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
set of OpenStack documentation, including forums.