blob: a72e783f12b9c10a96201373c300c8ac85394dde [file] [log] [blame]
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02001=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04002Tempest Testing Project
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02003=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04004
Masayuki Igawad787bc22016-06-29 14:30:24 +09005Overview
Masayuki Igawad2a657d2017-05-08 15:25:56 -04006========
Sean Dagueb56052b2013-05-21 17:57:41 -04007
8.. toctree::
9 :maxdepth: 2
10
11 overview
12
Sean Dague7679b482013-05-24 08:49:44 -040013Field Guides
Masayuki Igawad2a657d2017-05-08 15:25:56 -040014============
Sean Dague7679b482013-05-24 08:49:44 -040015Tempest contains tests of many different types, the field guides
16attempt to explain these in a way that makes it easy to understand
17where your test contributions should go.
Sean Dagueb56052b2013-05-21 17:57:41 -040018
19.. toctree::
Sean Dague7679b482013-05-24 08:49:44 -040020 :maxdepth: 1
Sean Dagueb56052b2013-05-21 17:57:41 -040021
22 field_guide/index
23 field_guide/api
Sean Dagueb56052b2013-05-21 17:57:41 -040024 field_guide/scenario
Matthew Treinish32d35702013-08-13 11:59:06 -040025 field_guide/unit_tests
Sean Dagueb56052b2013-05-21 17:57:41 -040026
Masayuki Igawae88caa82017-05-22 17:53:15 +090027Users Guide
28===========
Masayuki Igawad787bc22016-06-29 14:30:24 +090029
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050030Tempest Configuration Guide
31---------------------------
32
33.. toctree::
34 :maxdepth: 2
35
36 configuration
Mathew Oddenb389faa2015-07-30 20:24:08 +000037 sampleconf
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050038
David Patersonce781492014-09-18 01:07:01 -040039Command Documentation
40---------------------
41
42.. toctree::
43 :maxdepth: 1
44
Jane Zadorozhna00fc3dc2015-05-27 18:01:56 +030045 account_generator
David Patersonce781492014-09-18 01:07:01 -040046 cleanup
Stephen Lowriec8548fc2016-05-24 15:57:35 -050047 subunit_describe_calls
step682980c14ec2016-02-23 14:53:52 -050048 workspace
Matthew Treinisha051c222016-05-23 15:48:22 -040049 run
David Patersonce781492014-09-18 01:07:01 -040050
Ghanshyam Mann68600b12019-10-09 03:05:07 +000051Supported OpenStack Releases and Python Versions
52------------------------------------------------
53
54.. toctree::
55 :maxdepth: 1
56
57 supported_version
58
Masayuki Igawae88caa82017-05-22 17:53:15 +090059Developers Guide
60================
Masayuki Igawad787bc22016-06-29 14:30:24 +090061
Masayuki Igawad787bc22016-06-29 14:30:24 +090062Development
63-----------
64
65.. toctree::
66 :maxdepth: 2
67
68 HACKING
69 REVIEWING
70 microversion_testing
Ken'ichi Ohmichid8386a32017-03-31 10:56:58 -070071 test_removal
Matthew Treinishe8ab5f92017-03-01 15:25:39 -050072 write_tests
Masayuki Igawad787bc22016-06-29 14:30:24 +090073
Masayuki Igawad787bc22016-06-29 14:30:24 +090074Plugins
75-------
76
77.. toctree::
78 :maxdepth: 2
79
80 plugin
81 plugin-registry
82
Ghanshyam Mann235c2642020-04-16 16:55:56 -050083Tempest & Plugins Compatible Version Policy
84-------------------------------------------
85
86.. toctree::
87 :maxdepth: 2
88
89 tempest_and_plugins_compatible_version_policy
90
Masayuki Igawad787bc22016-06-29 14:30:24 +090091Library
92-------
93
94.. toctree::
95 :maxdepth: 2
96
97 library
98
ghanshyam247841e2018-06-19 09:26:22 +000099Support Policy
100--------------
101
102.. toctree::
103 :maxdepth: 2
104
105 stable_branch_support_policy
106
Masayuki Igawa7e4ef4c2019-07-03 17:17:44 +0900107Search
108======
Sean Dagueb56052b2013-05-21 17:57:41 -0400109
Masayuki Igawa7e4ef4c2019-07-03 17:17:44 +0900110.. only:: html
111
112 * :ref:`Tempest document search <search>`: Search the contents of this document.
113
114* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
Ghanshyam Mann235c2642020-04-16 16:55:56 -0500115 set of OpenStack documentation, including forums.