summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
blob: d4dc1665f8d818157203fcd27681d232eb8a6a0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
=======================
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
   requirement_upper_constraint_for_tempest

Plugins
-------

.. toctree::
   :maxdepth: 2

   plugins/index

Tempest & Plugins Compatible Version Policy
-------------------------------------------

.. toctree::
   :maxdepth: 2

   tempest_and_plugins_compatible_version_policy

Stable Branch Support Policy
----------------------------

.. toctree::
   :maxdepth: 2

   stable_branch_support_policy

Stable Branch Testing Policy
----------------------------

.. toctree::
   :maxdepth: 2

   stable_branch_testing_policy

Library
-------

.. toctree::
   :maxdepth: 2

   library

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.