summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/intro.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2018-04-04 05:31:23 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2018-04-04 20:15:31 +0200
commitfdc6191e3562b4ec327d899cd1a4c395ac1734ba (patch)
treee504a38d8b27545d2af0e25084c8e17e9495a7d3 /docs/testing/user/userguide/intro.rst
parent3cabf9dc69e8639db7bb72f05474dee4ece2ed97 (diff)
Fix Functest User Guide
It allows building this documentation via tox. rst files are now checked via doc8. Intro is moved into a new file. Change-Id: If1dbe2cbde2f39ca4948ada2b2743594bc387dbc Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> (cherry picked from commit 3756ff6fbd17269fd9d2a585d3d0ef4bea6f6f9e)
Diffstat (limited to 'docs/testing/user/userguide/intro.rst')
-rw-r--r--docs/testing/user/userguide/intro.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/intro.rst b/docs/testing/user/userguide/intro.rst
new file mode 100644
index 000000000..0c36cd8c7
--- /dev/null
+++ b/docs/testing/user/userguide/intro.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Introduction
+============
+
+The goal of this document is to describe the OPNFV Functest test cases and to
+provide a procedure to execute them.
+
+**IMPORTANT**: It is assumed here that Functest has been properly deployed
+following the installation guide procedure `[1]`_.
+
+.. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html