openstack/tempest
Code Issues Proposed changes

Fix minor details in README

Browse Source 
This commit makes 3 updates to the README. First it adds a link to the
official documentation at the top of the README. We've had a number of
bugs filed where people think the docs are broken because github
doesn't understand sphinx directives in its rst rendering. Including
a link to the openstack hosted logs will make it clear that the docs
output is only via sphinx. The second cleanup is adding an internal
link to the tempest configuration guide in the quickstart. The
quickstart alludes to configuring tempest, but never actually provides
an explanation on how to do it. Adding the link to the configuration
guide should clear up any potential confusion. The last change here is
removing the external shield images from the readme. These raise sphinx
warnings (which we want to stop), and violate at least one distros
packaging process for questionable value.

Closes-Bug: #1589428

Change-Id: I0f797478624df704c03a00bc3fae89bfcea5799a
This commit is contained in:
Matthew Treinish 2016-07-05 11:20:12 -04:00
parent 531b01c017
commit dced423202
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -1,13 +1,8 @@
Tempest - The OpenStack Integration Test Suite
==============================================
.. image:: https://img.shields.io/pypi/v/tempest.svg
:target: https://pypi.python.org/pypi/tempest/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/tempest.svg
:target: https://pypi.python.org/pypi/tempest/
:alt: Downloads
The documentation for Tempest is officially hosted at:
http://docs.openstack.org/developer/tempest/
This is a set of integration tests to be run against a live OpenStack
cluster. Tempest has batteries of tests for OpenStack API validation,
@ -90,7 +85,8 @@ as it is simpler, and quicker to work with.
config files located in the etc/ subdir created by the ``tempest init``
command. Tempest is expecting a tempest.conf file in etc/ so if only a
sample exists you must rename or copy it to tempest.conf before making
any changes to it otherwise Tempest will not know how to load it.
any changes to it otherwise Tempest will not know how to load it. For
details on configuring tempest refer to the :ref:`tempest-configuration`.
#. Once the configuration is done you're now ready to run Tempest. This can
be done using the :ref:`tempest_run` command. This can be done by either