From a068e664d61b037bee0ebef010c8151166cbe0f0 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Thu, 21 Dec 2017 11:14:43 +0100 Subject: [PATCH] Update README and setup.cfg, initial version of usage guide * Set setup.cfg URL to the (future) documentation link * Remove Python 3.3 and 3.4 support, leave only 3.5 * Update README with actual information * Include README in index.rst as an introduction * Very basic usage guide, mostly links to Tempest docs * Switch links to HTTPS Depends-On: If130b765604d606420a4877a548e82d311ef7b9b Change-Id: Idacf84322773e40eaaa6346dc062291578876a1d --- CONTRIBUTING.rst | 4 ++-- README.rst | 26 +++++++++++--------------- doc/source/index.rst | 9 +-------- doc/source/readme.rst | 1 - doc/source/usage.rst | 42 ++++++++++++++++++++++++++++++++++++++---- setup.cfg | 7 +++---- 6 files changed, 55 insertions(+), 34 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c0c5259..fa05b86 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,14 +1,14 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - http://docs.openstack.org/infra/manual/developers.html + https://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. diff --git a/README.rst b/README.rst index f6db1b1..80be9d5 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,15 @@ -=============================== -ironic-tempest-plugin -=============================== +============================================== +Tempest plugin for ironic and ironic-inspector +============================================== -Tempest plugin for ironic - -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +This repository contains a Tempest_ plugin for OpenStack `Bare Metal`_ and +`Bare Metal Introspection`_ projects. * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/ironic-tempest-plugin -* Source: http://git.openstack.org/cgit/openstack/ironic-tempest-plugin -* Bugs: http://bugs.launchpad.net/ironic +* Documentation: https://docs.openstack.org/ironic-tempest-plugin +* Source: https://git.openstack.org/cgit/openstack/ironic-tempest-plugin +* Bugs: https://bugs.launchpad.net/ironic -Features --------- - -* TODO +.. _Tempest: https://docs.openstack.org/tempest/latest/ +.. _Bare Metal: https://docs.openstack.org/ironic/latest/ +.. _Bare Metal Introspection: https://docs.openstack.org/ironic-inspector/latest/ diff --git a/doc/source/index.rst b/doc/source/index.rst index f13db7a..b036a93 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,17 +1,10 @@ -.. ironic-tempest-plugin documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to ironic-tempest-plugin's documentation! -======================================================== +.. include:: ../../README.rst Contents: .. toctree:: :maxdepth: 2 - readme installation usage contributing diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst index b608111..8ab88eb 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,41 @@ -======== +===== Usage -======== +===== -To use ironic-tempest-plugin in a project:: +Configuring +----------- - import ironic_tempest_plugin +Update your `Tempest configuration`_ to enable support for ironic: + +.. code-block:: ini + + [service_enabled] + ironic = True + +If introspection tests are needed, also enable support for ironic-inspector: + +.. code-block:: ini + + [service_enabled] + ironic_inspector = True + +.. TODO(dtantsur): I'm pretty sure more configuration is required, fill it in + +.. _Tempest configuration: https://docs.openstack.org/tempest/latest/configuration.html + +Running +------- + +Run tests as described in the `Tempest documentation`_. The following patterns +can be used with ``--regex`` option to only run bare metal tests: + +``ironic`` + all bare metal tests +``ironic_standalone`` + standalone bare metal tests that do not use the Compute service +``InspectorBasicTest`` + basic introspection tests +``InspectorDiscoveryTest`` + introspection auto-discovery tests + +.. _Tempest documentation: https://docs.openstack.org/tempest/latest/run.html diff --git a/setup.cfg b/setup.cfg index bfcddfc..64770b6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,11 +1,11 @@ [metadata] name = ironic-tempest-plugin -summary = Tempest plugin for ironic +summary = Tempest plugin for ironic and ironic-inspector description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://www.openstack.org/ +home-page = https://docs.openstack.org/ironic-tempest-plugin classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -16,8 +16,7 @@ classifier = Programming Language :: Python :: 2 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 - Programming Language :: Python :: 3.3 - Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 [files] packages =