summaryrefslogtreecommitdiffstats
path: root/docs/userguide/introduction.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-08-15 15:20:50 +0200
committerSofia Wallin <sofia.wallin@ericsson.com>2016-09-19 14:37:59 +0200
commite042f556c6c25858f328cb6287c164b2514a2561 (patch)
tree2e0a495f29d608e88602299116ea6c90cfabb9ce /docs/userguide/introduction.rst
parent15d5bdf0756bf3faa28558d4effd7611f1767146 (diff)
WIP: Created 2 introduction documents for user guide and installation
Work on the contant in both installation and user guide Started to add artifacts in the installation instruction and user guide This is a first draft of the installation.introduction.rst and userguide.introduction.rst. Some of the information has been reused from the Brahmaputra docs with modifications. Please comment and add as needed/wanted. Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/userguide/introduction.rst')
-rw-r--r--docs/userguide/introduction.rst65
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
deleted file mode 100644
index c702d47bc..000000000
--- a/docs/userguide/introduction.rst
+++ /dev/null
@@ -1,65 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-========
-Overview
-========
-
-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 Features
-==============
-
-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 scenarios are best for you and how to install and configure them
-on your infrastructure the
-`OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/index.html>`_
-provides a valuable 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
-`OPNFV Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/post-install.html>`_.
-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. Start by identifying the feature capability you would like to leverage, then read through
-the relevant user guide section to understand how to work with the feature.
-The combination of platform features, if available in a given scenario and not otherwise indicated,
-should operate according to the documentation.
-Dependencies between features will be highlighted in the user guide text.
-
-You may wish to use the platform in a manner that the development teams 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 been implemented. In either case it is important for OPNFV to learn about it as we are in
-essence a development project looking to ensure the required capabilities for our users are available.