x/tobiko
Code Issues Proposed changes

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

Browse Source 
* 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
This commit is contained in:
Assaf Muller 2019-05-01 15:30:21 -04:00
parent 1f2717321f
commit f301597e87
2 changed files with 13 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.rst
View File

@ -2,16 +2,17 @@
Tobiko Tobiko
====== ======
Tobiko is an OpenStack testing framework focusing on areas
complementary to Tempest:
Test Big Cloud 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
Tobiko is a project used to write system tests for OpenStack. Main projects tests that validate that the cloud workloads are still functional.
goals are: - Fault injection, like restarting nodes, OpenStack services and
dependencies such as OVS, RabbitMQ or the DB.
- provide a Python framework to write system scenario test cases; - White box testing; Specifically the ability to run commands on
- provide CLI tools to implement a workflow designed to test potentially nodes.
destructive operations.
Links Links
~~~~~ ~~~~~

25
doc/source/index.rst
View File

@ -1,26 +1,7 @@
Welcome to Tobiko Documentation! Tobiko
================================ ======
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>`__
.. include:: ../../README.rst
Document Overview Document Overview
----------------- -----------------