Browse Source

Clarify README.rst, remove duplication in docs/index.rst

* Add a simple explanation of what Tobiko is to README.rst
* Instead of duplicating README.rst content in to doc/index.rst,
  just pull the content from it via an rst directive.

Change-Id: I878bf9517fce54827bc5b4528bd1af695352f8cb
changes/99/656699/2
Assaf Muller 2 years ago
parent
commit
f301597e87
  1. 19
      README.rst
  2. 25
      doc/source/index.rst

19
README.rst

@ -2,16 +2,17 @@
Tobiko
======
Tobiko is an OpenStack testing framework focusing on areas
complementary to Tempest:
Test Big Cloud Operations
-------------------------
Tobiko is a project used to write system tests for OpenStack. Main projects
goals are:
- provide a Python framework to write system scenario test cases;
- provide CLI tools to implement a workflow designed to test potentially
destructive operations.
- Minor updates and major upgrades. Tobiko tests populate the
cloud with workloads such as instances, allows the CI workflow
to perform an operation such as an update or upgrade, and then runs
tests that validate that the cloud workloads are still functional.
- Fault injection, like restarting nodes, OpenStack services and
dependencies such as OVS, RabbitMQ or the DB.
- White box testing; Specifically the ability to run commands on
nodes.
Links
~~~~~

25
doc/source/index.rst

@ -1,26 +1,7 @@
Welcome to Tobiko Documentation!
================================
Test Big Cloud Operations
-------------------------
Tobiko is a project used to write system tests for OpenStack. Main projects
goals are:
- provide a Python framework to write system scenario test cases;
- provide CLI tools to implement a workflow designed to test potentially
destructive operations.
Links
~~~~~
* Documentation: `Tobiko Documentation <https://docs.openstack.org/tobiko/latest/>`__
* Usage: `Tobiko User Guide <https://docs.openstack.org/tobiko/latest/user/>`__
* Bugs: `Tobiko StoryBoard <https://storyboard.openstack.org/#!/project/x/tobiko>`__
* Source Code: https://opendev.org/x/tobiko.git
* License: `Apache License v2.0 <https://opendev.org/x/tobiko/src/branch/master/LICENSE>`__
Tobiko
======
.. include:: ../../README.rst
Document Overview
-----------------

Loading…
Cancel
Save