Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / packaging / sources / tempest / 24961f6244fd3798b26c0d516d18ab03cd764df8 / . / doc / source / index.rst
blob: d4dc1665f8d818157203fcd27681d232eb8a6a0e [file] [log] [blame]
Attila Fazekas23fdf1d2013-06-09 16:35:23 +0200[diff] [blame]1=======================
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]2Tempest Testing Project
Attila Fazekas23fdf1d2013-06-09 16:35:23 +0200[diff] [blame]3=======================
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]4
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]5Overview
Masayuki Igawad2a657d2017-05-08 15:25:56 -0400[diff] [blame]6========
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]7
8.. toctree::
9 :maxdepth: 2
10
11 overview
12
Sean Dague7679b482013-05-24 08:49:44 -0400[diff] [blame]13Field Guides
Masayuki Igawad2a657d2017-05-08 15:25:56 -0400[diff] [blame]14============
Sean Dague7679b482013-05-24 08:49:44 -0400[diff] [blame]15Tempest 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 -0400[diff] [blame]18
19.. toctree::
Sean Dague7679b482013-05-24 08:49:44 -0400[diff] [blame]20 :maxdepth: 1
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]21
22 field_guide/index
23 field_guide/api
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]24 field_guide/scenario
Matthew Treinish32d35702013-08-13 11:59:06 -0400[diff] [blame]25 field_guide/unit_tests
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]26
Masayuki Igawae88caa82017-05-22 17:53:15 +0900[diff] [blame]27Users Guide
28===========
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]29
Matthew Treinishbc1b15b2015-02-20 15:56:07 -0500[diff] [blame]30Tempest Configuration Guide
31---------------------------
32
33.. toctree::
34 :maxdepth: 2
35
36 configuration
Mathew Oddenb389faa2015-07-30 20:24:08 +0000[diff] [blame]37 sampleconf
Matthew Treinishbc1b15b2015-02-20 15:56:07 -0500[diff] [blame]38
David Patersonce781492014-09-18 01:07:01 -0400[diff] [blame]39Command Documentation
40---------------------
41
42.. toctree::
43 :maxdepth: 1
44
Jane Zadorozhna00fc3dc2015-05-27 18:01:56 +0300[diff] [blame]45 account_generator
David Patersonce781492014-09-18 01:07:01 -0400[diff] [blame]46 cleanup
Stephen Lowriec8548fc2016-05-24 15:57:35 -0500[diff] [blame]47 subunit_describe_calls
step682980c14ec2016-02-23 14:53:52 -0500[diff] [blame]48 workspace
Matthew Treinisha051c222016-05-23 15:48:22 -0400[diff] [blame]49 run
David Patersonce781492014-09-18 01:07:01 -0400[diff] [blame]50
Ghanshyam Mann68600b12019-10-09 03:05:07 +0000[diff] [blame]51Supported OpenStack Releases and Python Versions
52------------------------------------------------
53
54.. toctree::
55 :maxdepth: 1
56
57 supported_version
58
Ghanshyam Mann95c410a2020-04-19 17:44:59 -0500[diff] [blame]59For Contributors
60================
61
62* If you are a new contributor to Tempest please refer: :doc:`contributor/contributing`
63
64.. toctree::
65 :hidden:
66
67 contributor/contributing
68
Masayuki Igawae88caa82017-05-22 17:53:15 +0900[diff] [blame]69Developers Guide
70================
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]71
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]72Development
73-----------
74
75.. toctree::
76 :maxdepth: 2
77
78 HACKING
79 REVIEWING
80 microversion_testing
Ken'ichi Ohmichid8386a32017-03-31 10:56:58 -0700[diff] [blame]81 test_removal
Matthew Treinishe8ab5f92017-03-01 15:25:39 -0500[diff] [blame]82 write_tests
Ghanshyam Mannd89122b2020-07-06 16:31:28 -0500[diff] [blame]83 requirement_upper_constraint_for_tempest
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]84
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]85Plugins
86-------
87
88.. toctree::
89 :maxdepth: 2
90
Ghanshyam Mannda3bb612020-05-04 20:52:01 -0500[diff] [blame]91 plugins/index
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]92
Ghanshyam Mann235c2642020-04-16 16:55:56 -0500[diff] [blame]93Tempest & Plugins Compatible Version Policy
94-------------------------------------------
95
96.. toctree::
97 :maxdepth: 2
98
99 tempest_and_plugins_compatible_version_policy
100
Ghanshyam Mannda3bb612020-05-04 20:52:01 -0500[diff] [blame]101Stable Branch Support Policy
102----------------------------
103
104.. toctree::
105 :maxdepth: 2
106
107 stable_branch_support_policy
108
Ghanshyam Mann96800bb2020-05-04 19:51:37 -0500[diff] [blame]109Stable Branch Testing Policy
110----------------------------
111
112.. toctree::
113 :maxdepth: 2
114
115 stable_branch_testing_policy
116
Masayuki Igawad787bc22016-06-29 14:30:24 +0900[diff] [blame]117Library
118-------
119
120.. toctree::
121 :maxdepth: 2
122
123 library
124
Masayuki Igawa7e4ef4c2019-07-03 17:17:44 +0900[diff] [blame]125Search
126======
Sean Dagueb56052b2013-05-21 17:57:41 -0400[diff] [blame]127
Masayuki Igawa7e4ef4c2019-07-03 17:17:44 +0900[diff] [blame]128.. only:: html
129
130 * :ref:`Tempest document search <search>`: Search the contents of this document.
131
132* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
Ghanshyam Mann235c2642020-04-16 16:55:56 -0500[diff] [blame]133 set of OpenStack documentation, including forums.