x
/
opencafe
Code Issues Proposed changes

Merge "Adding a quick blurb about what OpenCAFE is"

This commit is contained in:
Jenkins 2014-02-07 18:43:03 +00:00 committed by Gerrit Code Review
parent 916d666923 a1ac58a757
commit 4102a11416
1 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/source/index.rst
View File

@ -1,9 +1,32 @@
.. _repository: https://github.com/CafeHub/opencafe
====================================
Welcome to OpenCAFE's documentation!
====================================
What is OpenCAFE
==================
The Common Automation Framework Engine (CAFE) is the core engine/driver used to build an automated testing framework. It is designed to be used as the base engine for building an automated framework for API and non-UI resource testing. It is designed to support functional, integration and reliability testing. The engine is NOT designed to support performance or load testing.
CAFE core provides models, patterns, and supported libraries for building automated tests. It provides its own lightweight unittest based runner, however, it is designed to be modular. It can be extended to support most test case front ends/runners (nose, pytest, lettuce, testr, etc...) through driver plug-ins.
.. note::
Questions? Join us on Freenode in the #cafehub channel
Relevant Links
================
* GitHub: `Repository`_
* CI: *Coming soon*
* Coverage: *Coming soon*
Contents
============
.. toctree::
:maxdepth: 3
:maxdepth: 2
getting_started/index
contributing/index
@ -17,5 +40,4 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`