aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlanqinglong <lanqinglong@huawei.com>2016-01-21 11:50:11 +0800
committerlanqinglong <lanqinglong@huawei.com>2016-01-21 11:50:11 +0800
commitb3d1ec25c7e538781717b012e2183a7f98b1c85a (patch)
tree66cc0c9a88ef77b59d807e605de5e25d013a5e21
parent5bf00d4594c28477f55521c9a72328e8d1b30c30 (diff)
update docs for onosfw
Change-Id: I22e5ddb68a93f736f805e2f1a10c72529a7195cc
-rw-r--r--docs/configguide/config-for-installer.rst5
-rw-r--r--docs/release/index.rst10
-rw-r--r--docs/release/onos-release.rst47
-rw-r--r--docs/userguide/onosfw-userguide.rst7
4 files changed, 57 insertions, 12 deletions
diff --git a/docs/configguide/config-for-installer.rst b/docs/configguide/config-for-installer.rst
index 02c1c720..7dd73cd9 100644
--- a/docs/configguide/config-for-installer.rst
+++ b/docs/configguide/config-for-installer.rst
@@ -8,7 +8,8 @@
:width: 200
:alt: OPNFV
:align: left
-
+|
+|
Config Documentation of onos & apex
===================================
@@ -31,8 +32,6 @@ Contents:
-* :ref:`search`
-
Revision: _sha1_
Build date: |today|
diff --git a/docs/release/index.rst b/docs/release/index.rst
index 36710b32..e833a7ae 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -8,9 +8,11 @@
:width: 200
:alt: OPNFV
:align: left
-
-Example Documentation table of contents
-=======================================
+|
+|
+ONOSFW Release Notes
+====================
+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.
Contents:
@@ -18,7 +20,7 @@ Contents:
:numbered:
:maxdepth: 4
- documentation-example.rst
+ onos-release.rst
Indices and tables
==================
diff --git a/docs/release/onos-release.rst b/docs/release/onos-release.rst
new file mode 100644
index 00000000..cab9f1f2
--- /dev/null
+++ b/docs/release/onos-release.rst
@@ -0,0 +1,47 @@
+.. 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
+|
+|
+ONOS Release
+============
+
+ONOS wiki of onosfw : `onosfw proposal in ONOS`_.
+
+.. _onosfw proposal in ONOS: https://wiki.onosproject.org/login.action?os_destination=%2Fdisplay%2FONOS%2FONOS%2BFramework%2B%28ONOSFW%29%2Bfor%2BOPNFV
+
+ONOS Emu code:`ONOS Emu Code`_.
+
+.. _ONOS Emu Code: https://github.com/opennetworkinglab/onos/tree/onos-1.4
+
+ONOS Emu Release Note `ONOS Emu Release Note`_.
+
+.. _ONOS Emu Release Note: https://wiki.onosproject.org/display/ONOS/Release+Notes+-+Emu+1.4.0
+
+The APIs docs exist as a submodule in docs/apis.
+In order to retrieve them, you must change directories to "apis" and then do a "git pull origin master".
+This will pull down all relevant API documents related to the source components in this release".
+here is api link: https://github.com/onosfw/apis
+
+OpenStack Release
+=================
+
+OpenStack Liberty wiki page `OpenStack Liberty wiki`_.
+
+.. _OpenStack Liberty wiki : https://wiki.openstack.org/wiki/Main_Page
+
+OpenStack Liberty api page `OpenStack Networking Api`_.
+
+.. _OpenStack Networking Api : http://developer.openstack.org/api-ref-networking-v2-ext.html
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/userguide/onosfw-userguide.rst b/docs/userguide/onosfw-userguide.rst
index 53a1cbb9..a791207b 100644
--- a/docs/userguide/onosfw-userguide.rst
+++ b/docs/userguide/onosfw-userguide.rst
@@ -8,7 +8,8 @@
:width: 200
:alt: OPNFV
:align: left
-
+|
+|
ONOSFW User Guide Manaully
==========================
@@ -80,10 +81,6 @@ ONOSFW User Guide Manaully
ONOSFW L2 Function Demo video:https://www.youtube.com/watch?v=qP8nPYhz_Mo
ONOSFW L3 Function Demo video:https://www.youtube.com/watch?v=R0H-IibpVxw
-Indices and tables
-==================
-
-* :ref:`search`
Revision: _sha1_