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
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