summaryrefslogtreecommitdiffstats
path: root/docs/userguide/introduction.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-27 09:25:06 +0100
committerChristopher Price <christopher.price@ericsson.com>2016-01-28 12:31:04 +0000
commit00189df66bad2b629bfeda267d540ab10fcd047e (patch)
treee7227f7478a5d244a602d2d1574380f917da85fc /docs/userguide/introduction.rst
parent5816766e8a23c6d6dda2730c02d34270c8f7f012 (diff)
Including text and graphic placeholders for the user and config guides. (I like apostrophes'')
This patch contains the introduction and framing text for the user and config guide. Work is required to add the scenario/feature mapping section and information. Change-Id: I71c9fa7cfbac2d0100c743a8855df4a02cc7482c Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/userguide/introduction.rst')
-rw-r--r--docs/userguide/introduction.rst61
1 files changed, 58 insertions, 3 deletions
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index a492c6efb..9ac9f0814 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -1,4 +1,59 @@
-OPNFV User Guide
-================
+Overview
+========
-Outline the structure and composition of the User Guide in this section.
+OPNFV provides a variety of virtual infrastructure deployments designed to
+host virtualised network functions (VNFs). This guide intends to help users of
+the platform leverage the features and capabilities delivered by the OPNFV project.
+
+OPNFV Continuous Integration builds, deploys and tests combinations of virtual
+infrastructure components in what are defined as scenarios. A scenario may include
+components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will
+include different source components or configurations. Scenarios are designed to
+enable specific features and capabilities in the platform that can be leveraged by the
+OPNFV user community.
+
+OPNFV Scenarios
+----------------
+
+Each OPNFV scenario provides unique features and capabilities, it is important to
+ensure you have a scenario deployed on your infrastructure that provides the right capabilities
+for your needs before working through the user guide.
+
+This user guide outlines how to work with key components and features in the platform,
+each feature description section will indicate the scenarios that provide the components
+and configurations required to use it.
+
+.. include:: ../scenario/featurematrix.rst
+
+For details on which scenario's are best for you and how to install and configure them
+on your infrastructure the `OPNFV Configuration guide
+<http://artifacts.opnfv.org/opnfvdocs/docs/configguide/index.html>`_ provides a definitive
+reference.
+
+The user guide will describe how to enable and utilise features and use cases implemented and
+tested on deployed OPNFV scenarios. For details of the use cases and tests that have been run
+you should check the validation procedures section of the features configuration guide. This will
+provide information about the specific use cases that have been validated and are working
+on your deployment.
+
+General usage guidelines
+------------------------
+
+The user guide for OPNFV features and capabilities provide step by step instructions
+for using features that have been configured according to the installation and configuration
+instructions.
+
+This guide is structured in a manner that will provide usage instructions for each feature in its own
+section. Identify the feature capability you would like to leverage and read through that user guide
+section to understand the available usage. The combination of platform features, if available in a given
+scenario and not otherwise indicated, should function by following each features section.
+Dependencies between features will be highlighted in the user guide text.
+
+You may wish to use the platform in a manner that the development team have not foreseen, or
+exercise capabilities not fully validated on the platform. If you experience issues leveraging the
+platform for the uses you have envisioned the `OPNFV user mailing list <"mailto:opnfv-user@lists.opnfv.org">`_
+provides a mechanism to establish a dialog with the community to help you overcome any issues identified.
+
+It may be that you have identified a bug in the system, or that you are trying to execute a use case
+that has not yet ben implemented. In either case OPNFV is in essence a development project
+looking to ensure the required capabilities for our users are available.