openstack/tempest
Code Issues Proposed changes
a27f15fec1
tempest/doc/source/index.rst

87 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Tempest Coding Guide * Adding HACKING.rst as Tempest Coding Guide * Fixing the section/title formater markup's length Change-Id: Ic61d287cd3bbf3adc5f7d98b17957a5be125f613
2013-06-09 16:35:23 +02:00
=======================
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
Tempest Testing Project
Tempest Coding Guide * Adding HACKING.rst as Tempest Coding Guide * Fixing the section/title formater markup's length Change-Id: Ic61d287cd3bbf3adc5f7d98b17957a5be125f613
2013-06-09 16:35:23 +02:00
=======================
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
Tidy up document index page This commit tidies up the tempest document index page. The tempest docs are increasing day by day. It's really good however I feel it's a little messy these days. So let's tidy up :) Change-Id: I4d34934b8d1a157bf38a8f2cafe5de1ba0e6098c
2016-06-29 14:30:24 +09:00
Overview
Update document theme and section headers This commit updates the document theme. It is clear, simple, up-to-date and beautiful. And this commit also updates section headers to fix the document index. Change-Id: Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4
2017-05-08 15:25:56 -04:00
========
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
.. toctree::
:maxdepth: 2
overview
update docs for consistency adjust the index file to be more readable for the field guide adjust titles to make more sense when displayed in top level index change theme to 'nature', which is closer to the openstack default style. Will eventually write our own style here. Change-Id: I4f5fed65f9e26a4e4d333b1be4ed02c9ec246b9a
2013-05-24 08:49:44 -04:00
Field Guides
Update document theme and section headers This commit updates the document theme. It is clear, simple, up-to-date and beautiful. And this commit also updates section headers to fix the document index. Change-Id: Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4
2017-05-08 15:25:56 -04:00
============
update docs for consistency adjust the index file to be more readable for the field guide adjust titles to make more sense when displayed in top level index change theme to 'nature', which is closer to the openstack default style. Will eventually write our own style here. Change-Id: I4f5fed65f9e26a4e4d333b1be4ed02c9ec246b9a
2013-05-24 08:49:44 -04:00
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.
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
.. toctree::
update docs for consistency adjust the index file to be more readable for the field guide adjust titles to make more sense when displayed in top level index change theme to 'nature', which is closer to the openstack default style. Will eventually write our own style here. Change-Id: I4f5fed65f9e26a4e4d333b1be4ed02c9ec246b9a
2013-05-24 08:49:44 -04:00
:maxdepth: 1
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
field_guide/index
field_guide/api
field_guide/scenario
Add unittest framework + tests for wrapper scripts This commit adds a framework for running unittests on tempest to verify that tempest works as expect. The first tests added are to verify the response codes of the test runner wrapper scripts we use on jenkins jobs. Change-Id: If8e91238054593999e7b5bc34da499bd0ac02311
2013-08-13 11:59:06 -04:00
field_guide/unit_tests
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
Fix minor header wordings This commit fixes minor header wordings which were mentioned in the previous patch review[1]. [1] Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4 Change-Id: I4db09bda5628371186e3548143c59d0841fcb7b0
2017-05-22 17:53:15 +09:00
Users Guide
===========
Tidy up document index page This commit tidies up the tempest document index page. The tempest docs are increasing day by day. It's really good however I feel it's a little messy these days. So let's tidy up :) Change-Id: I4d34934b8d1a157bf38a8f2cafe5de1ba0e6098c
2016-06-29 14:30:24 +09:00
Add tempest config guide doc This commit adds a new doc page to the tempest documentation to provide a guide to configuring tempest. It currently contains one section to elaborate on the credentials and auth options in the config file. This doc will be expanded in the future to add details around other pieces of tempest configuration. Change-Id: Iaf7cefc6a5e508437e4b4620ba5bfaa221f3611b
2015-02-20 15:56:07 -05:00
Tempest Configuration Guide
---------------------------
.. toctree::
:maxdepth: 2
configuration
Include sample configuration in dev docs Since including the sample configuration in tree is becoming difficult to maintain, lets try moving it to the developer docs. We still have the ability to view it easily for users, and it can be auto-generated on doc build, so it should also always be up to date. Change-Id: I7ec2d76448feef5ecb9af7c238bbd12619fa31d8
2015-07-30 20:24:08 +00:00
sampleconf
Add tempest config guide doc This commit adds a new doc page to the tempest documentation to provide a guide to configuring tempest. It currently contains one section to elaborate on the credentials and auth options in the config file. This doc will be expanded in the future to add details around other pieces of tempest configuration. Change-Id: Iaf7cefc6a5e508437e4b4620ba5bfaa221f3611b
2015-02-20 15:56:07 -05:00
Add tempest post-run cleanup script Implemented all features defined in blueprint. Change-Id: If3c9b82f85095eeb22bbf32841be534024213567 Implements: blueprint post-run-cleanup
2014-09-18 01:07:01 -04:00
Command Documentation
---------------------
.. toctree::
:maxdepth: 1
Added documentation to tempest-account-generator Added docstring to cmd/account_generator.py. Fixed help messages. Added sphinx documentation for tempest-account-generator utility. Change-Id: I6640ba8a0eaaea187cf38582ab537394dec020b6
2015-05-27 18:01:56 +03:00
account_generator
Add tempest post-run cleanup script Implemented all features defined in blueprint. Change-Id: If3c9b82f85095eeb22bbf32841be534024213567 Implements: blueprint post-run-cleanup
2014-09-18 01:07:01 -04:00
cleanup
Add subunit-describe-calls Adds new command subunit-describe-calls, documentation, and unittests. subunit-describe-calls is a parser for subunit v1 & v2 streams to determine what REST API calls are made inside of a test and in what order they are called. Later commits will add additional functionality relating to request & response headers & body data along with a stdout output option and stdin input. Change-Id: I468d0d3e3b6098da95a81cc86d9bdd1b47ee1f03
2016-05-24 15:57:35 -05:00
subunit_describe_calls
Centralized Workspaces Create a consistent means for creation and management of Tempest workspaces. Creates a file located at ~/.tempest/workspaces.yaml which stores existing workspaces. Available subcommands: list, register, rename, move, remove bp centralized-workspaces Change-Id: I9595e3ba809e457951a0ffdf4b15f641f2fec4f4
2016-02-23 14:53:52 -05:00
workspace
Add tempest run command This commit adds a new run command to the unified cli endpoint. The intent here is for tempest to control it's own run story. This implements the basic runner and selection functionality to use the command, however it's not necessarily the end state of the command. The functionality in this patch is just a starting point to add the command and the basic functionality needed. It is starting with a limited feature set with the intent to add additional, more complex functionality in self contained patches after the command exists. Co-Authored-by: David Paterson <davpat2112@yahoo.com> Co-Authored-by: Stephen Lowrie <stephen.lowrie@rackspace.com> Partially-Implements bp tempest-run-cmd Depends-On: I09299043e536521d48dbe10632621138e3a366e0 Change-Id: I24588b5c00d005320e8719cf82b5dd95662572cf
2016-05-23 15:48:22 -04:00
run
Add tempest post-run cleanup script Implemented all features defined in blueprint. Change-Id: If3c9b82f85095eeb22bbf32841be534024213567 Implements: blueprint post-run-cleanup
2014-09-18 01:07:01 -04:00
Fix minor header wordings This commit fixes minor header wordings which were mentioned in the previous patch review[1]. [1] Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4 Change-Id: I4db09bda5628371186e3548143c59d0841fcb7b0
2017-05-22 17:53:15 +09:00
Developers Guide
================
Tidy up document index page This commit tidies up the tempest document index page. The tempest docs are increasing day by day. It's really good however I feel it's a little messy these days. So let's tidy up :) Change-Id: I4d34934b8d1a157bf38a8f2cafe5de1ba0e6098c
2016-06-29 14:30:24 +09:00
Development
-----------
.. toctree::
:maxdepth: 2
HACKING
REVIEWING
microversion_testing
Rename test-removal.rst All other rst files don't contain "-" in the file names instead of '_'. This patch renames test-removal.rst for consistent format on rst files. TrivialFix Change-Id: I229870baa1954e1f6b2277318ae5bae332f660ad
2017-03-31 10:56:58 -07:00
test_removal
Add tempest test writing guide This commit is the start of a new doc guide for helping people figure out how to write good tempest tests. This is just a starting point for the document and doesn't cover every aspect of writing a test case in tempest. Right now it just covers the setupClass phase for writing TestCases. It will be expanded upon in future commits to give a complete guide to writing tests in Tempest. Change-Id: Ie0db2079163f536ae72668c8fc9129ae4c6389e2
2017-03-01 15:25:39 -05:00
write_tests
Tidy up document index page This commit tidies up the tempest document index page. The tempest docs are increasing day by day. It's really good however I feel it's a little messy these days. So let's tidy up :) Change-Id: I4d34934b8d1a157bf38a8f2cafe5de1ba0e6098c
2016-06-29 14:30:24 +09:00
Plugins
-------
.. toctree::
:maxdepth: 2
plugin
plugin-registry
Library
-------
.. toctree::
:maxdepth: 2
library
initial seed for tempest doc directory This is a first bit of experiment to get a doc tree for tempest that will publish our doc content to the web as part of a larger QA doc guide. Update some of the base READMEs to be a little more accurate, now that we're going to be pushing them to the web. Added tox [venv] to ensure that docs get built Change-Id: Id54e8fbc1d884525087630106e17b37dc1206cc9
2013-05-21 17:57:41 -04:00
Indices and tables
==================
* :ref:`search`
Copy Permalink