Add document template for usecase-ui

Change-Id: Ia1a8ca6e09dbf78f4265438f73d2ad59c74ca857
Issue-Id: USECASEUI-48
Signed-off-by: shentao <shentao@chinamobile.com>

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
index 0000000..20ac211
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+VF-C Architecture
+-----------------
+Following is the VF-C architecture.
+
+
+|image0|
+
+.. |image0| image:: vfc-arc.png
+   :width: 5.97047in
+   :height: 5.63208in
+   
+VF-C includes two components: NFVO and GVNFM
+
+VF-C has many dependencies with other projects,such as SO,Policy,A&AI,SDC,DCAE,Multi-cloud and so on.
\ No newline at end of file

diff --git a/docs/components.png b/docs/components.png
new file mode 100644 (file)
index 0000000..253e63b
Binary files /dev/null and b/docs/components.png differ

diff --git a/docs/delivery.rst b/docs/delivery.rst
new file mode 100644 (file)
index 0000000..f31d396
--- /dev/null
+++ b/docs/delivery.rst
@@ -0,0 +1,13 @@
+VF-C Delivery
+--------
+VF-C includs the following components in R1.
+
+|image0|
+
+.. |image0| image:: components.png
+   :width: 5.97047in
+   :height: 5.63208in
+   
+
+
+

diff --git a/docs/index.rst b/docs/index.rst
index 833e1aa..50e8bbb 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,21 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _usecase-ui_index:
+
+ONAP USECASE-UI
+=========
+
+Usecase UI is the ONAP subsystem that provides self-service management GUI for operators and end-users from the point of view of use cases. This project targets identifying all GUI requirements which operators and end-users need ONAP to support, coordinating GUI parts of each ONAP subsystem, filling the gaps for improving GUI functionalities for use cases.
+
+* support service lifecycle management of VoLTE Use Case that complex services can be simply done by one click.
+* support showing system alarm information.
+* support showing system performance information.
+
 
-TODO Add files to toctree and delete this header
-------------------------------------------------
 .. toctree::
    :maxdepth: 1
 
-
+   architecture.rst
+   delivery.rst
+   installation.rst

diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644 (file)
index 0000000..efdf816
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+VF-C Installation
+------------
+Describe the environment and steps to install VF-C components.
+
+
+Environment
++++++++++++
+
+
+Steps
++++++

diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100644 (file)
index 0000000..8d480e2
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging & Diagnostic Information
+--------------------------------
+Description of how to interact with and diagnose problems with the components
+as delivered.
+
+Where to Access Information
++++++++++++++++++++++++++++
+
+
+Error / Warning Messages
+++++++++++++++++++++++++

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644 (file)
index 0000000..79af664
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,43 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+VF-C Offered APIs
+=================
+List VF-C APIs offered.
+
+
+NS LCM API
+----------
+
+Network services lifecycle management APIs
+
+
+.. toctree::
+   :maxdepth: 1
+   
+   APIs/NSLCM_API/index
+
+
+VNFM Driver API 
+---------------
+
+VNFM Driver component northbound APIs
+
+.. toctree:: 
+   :maxdepth: 1
+   
+   APIs/VNFMDriver_API/index
+
+
+
+VNF LCM API
+-----------
+
+VNF lifecycle management APIs
+
+.. toctree:: 
+   :maxdepth: 1
+
+   APIs/VNFLCM_API/index
+

diff --git a/docs/vfc-arc.png b/docs/vfc-arc.png
new file mode 100644 (file)
index 0000000..561488b
Binary files /dev/null and b/docs/vfc-arc.png differ