update onosfw documents

Change-Id: Iebe0a271e2ae216587609b17ae56864bc2d46b2f

1 files changed, 58 insertions, 15 deletions

diff --git a/docs/userguide/onosfw-userguide.rst b/docs/userguide/onosfw-userguide.rst
index a791207b..ab5297fd 100644
--- a/docs/userguide/onosfw-userguide.rst
+++ b/docs/userguide/onosfw-userguide.rst
@@ -1,18 +1,55 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-|
-|
+==========================
+ONOSFW User Guide Manaully
+==========================
+
+.. contents:: Table of Contents
+   :backlinks: none
+
+
+Abstract
+========
+
+This document describes the user guide instruction for onosfw project, including env setup and test case.
+
+License
+=======
+
+ONOSFW User Guide Manaully Docs
+(c) by Henry (HUAWEI)
+
+ONOSFW User Guide Manaully Docs
+are licensed under a Creative Commons Attribution 4.0 International License.
+You should have received a copy of the license along with this.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
+
+Version history
+===============
+
++------------+----------+------------+------------------+
+| **Date**   | **Ver.** | **Author** | **Comment**      |
+|            |          |            |                  |
++------------+----------+------------+------------------+
+| 2016-01-21 | 1.0.0    | Henry      | Rewritten for    |
+|            |          | (HUAWEI)   | ONOSFW B release |
++------------+----------+------------+------------------+
+| 2016-01-20 | 0.0.2    | Henry      | Minor changes &  |
+|            |          | (HUAWEI)   | formatting       |
++------------+----------+------------+------------------+
+| 2016-01-19 | 0.0.1    | Henry      | First draft      |
+|            |          | (HUAWEI)   |                  |
++------------+----------+------------+------------------+
+
+Introduction
+============
+
+ONOSFW addresses integrating an SDN controller of choice based on a target applications or use cases within the OPNFV defined NFVI and VIM framework. It aims to provide end user and open source community with greater flexibility to build service applications, and to help leverage corresponding open source development efforts and results as well. Furthermore, it will create some common framework elements to address multi tenancy support, integration between the network controller and a DPI engine for context-based flow policies. It will also provide driver integration to support the Neutron ML2 & Router plugin.
+
+
 ONOSFW User Guide Manaully
 ==========================
 
+ONOSFW Environment Setup
+------------------------
  1. initialize environment::
 
    initialize openstack：delete allthe network, instance and router.
@@ -41,9 +78,12 @@ ONOSFW User Guide Manaully
 
    externalgateway-update -m “mac address”
 
- 6. create basic networks and instances on openstack dashboard to verify L2/L3function::
+ 6. create basic networks and instances on openstack dashboard to verify L2/L3function
 
- * L2 scene:
+Scenario Supported
+------------------
+
+* L3 scene:
 
    * Live Migration
 
@@ -74,7 +114,8 @@ ONOSFW User Guide Manaully
    * With between different nodes under the different tenant and different network wether the vm is not conneted
    VM can ping external network well
    
- Video:
+ONOSFW Demo Video
+-----------------
 
     ONOSFW L2 Function Flash video：https://www.youtube.com/watch?v=7bxjWrR4peI
 
@@ -84,4 +125,6 @@ ONOSFW User Guide Manaully
 
 Revision: _sha1_
 
+:Author: Henry(jiangrui1@huawei.com)
+
 Build date: |today|