From dced423202be99dffcda21b85e14faa2c58aa46f Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Tue, 5 Jul 2016 11:20:12 -0400 Subject: [PATCH] Fix minor details in README 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 --- README.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index b44df651ec..53c7de5764 100644 --- a/README.rst +++ b/README.rst @@ -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