Add docs for workflow designer

Add docs

Issue-ID: SDC-636

Change-Id: I7246a974e16850b4dce37d384e09c8b400044442
Signed-off-by: Lvbo163 <lv.bo163@zte.com.cn>

diff --git a/docs/index.rst b/docs/index.rst
index 833e1aa..7198c38 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,16 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-TODO Add files to toctree and delete this header
+SDC-Workflow-Designer
 ------------------------------------------------
+
+Workflow Designer provides the ablitilty to design a bpmn workflow. It extends restful task and tosca task. so it can be combined with tosca template easily.
+
+This document is aimed to give the users some brief introductions of Workflow Designer. The users could find useful information, e.g. the architecture, the APIs and the installation steps, etc. as well as the release notes in this document.
+
 .. toctree::
    :maxdepth: 1
+   
+   platform/index.rst
+   release-notes.rst
 
 

diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
new file mode 100644 (file)
index 0000000..8569dd9
--- /dev/null
+++ b/docs/platform/architecture.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+
+Architecture
+------------
+SDC Workflow Designer is a workflow design tool. It implements bpmn workflow standards. And it extends some elements for tosca specification. So in this designer the users can orchestrate services and interactive with tosca template more easily.
+
+SDC Workflow Designer is a component of SDC. Right now it doesn't depend on other components. It can work alone. In the future, it will depend on MSB and SDC Catalog. 
+
+SDC Workflow Designer contains two parts: UI, Backend.
+
+.. image:: images/workflow-architecture.png
+
+UI is the designer. It can access SDC Catalog to get tosca template info. Users can orchestrate ONAP services.
+
+Backend is the storage of Workflow Designer. It will translate the workflow definition to standard bpmn workflow. And it can save workflow artifact to SDC catalog.
\ No newline at end of file

diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst
new file mode 100644 (file)
index 0000000..c18f59b
--- /dev/null
+++ b/docs/platform/consumedapis.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+-------------
+
+In the Amsterdam release, Workflow Designer does not consume any APIs provided by other ONAP components. It will consume apis of MSB and SDC in the future.

diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst
new file mode 100644 (file)
index 0000000..af33c9d
--- /dev/null
+++ b/docs/platform/delivery.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+
+Delivery
+--------
+
+:Docker:
+ - onap/sdc/sdc-workflow-designer
+Docker containers can be downloaded from ONAP docker repository https://nexus3.onap.org/.
+ 

diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst
new file mode 100644 (file)
index 0000000..4a0484e
--- /dev/null
+++ b/docs/platform/human-interfaces.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+----------------
+SDC Workflow Designer provides a Web GUI Portal for users.
+Users can orchestrate services. Right now, the designer supports parse swagger. Users can set services for every workflow by swagger.
+
+Target Users
+^^^^^^^^^^^^
+Workflow designer.
+
+Interface Type
+^^^^^^^^^^^^^^
+Web GUI.
+
+Access
+^^^^^^
+Http://MSB_API_GATEWAY_IP:80/workflow
\ No newline at end of file

diff --git a/docs/platform/images/workflow architecture.PNG b/docs/platform/images/workflow architecture.PNG
new file mode 100644 (file)
index 0000000..35dcf7b
Binary files /dev/null and b/docs/platform/images/workflow architecture.PNG differ

diff --git a/docs/platform/index.rst b/docs/platform/index.rst
new file mode 100644 (file)
index 0000000..e63fde5
--- /dev/null
+++ b/docs/platform/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Platform
+--------
+
+Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
+
+.. toctree::
+   :maxdepth: 1
+   
+   architecture.rst
+   offeredapis.rst
+   consumedapis.rst
+   delivery.rst
+   log-and-diagnostic-info.rst
+   installation.rst
+   administration.rst
+   human-interfaces.rst

diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst
new file mode 100644 (file)
index 0000000..7362603
--- /dev/null
+++ b/docs/platform/installation.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Installation
+------------
+
+Install docker
+^^^^^^^^^^^^^^^^^^^^^^^
+
+sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'
+
+sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
+
+sudo apt-get update
+
+apt-cache policy docker-engine
+
+sudo apt-get install -y docker-engine
+
+docker ps
+
+Run sdc-workflow-designer docker
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Login the ONAP docker registry first: sudo docker login -u docker -p docker nexus3.onap.org:10001
+
+sudo docker run -p  9519:8080 -d --net=host --name sdc-workflow-designer nexus3.onap.org:10001/onap/sdc/sdc-workflow-designer
+
+Check status of Workflow designer
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Visit workflow designer web ui:
+
+http://127.0.0.1:9527/
\ No newline at end of file

diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
new file mode 100644 (file)
index 0000000..f179df4
--- /dev/null
+++ b/docs/platform/offeredapis.rst
@@ -0,0 +1,4 @@
+Offered APIs
+------------
+
+Right now, SDC Workflow Designer just provide a web UI. It will provides APIs in the future release.
\ No newline at end of file

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..299586f
--- /dev/null
+++ b/docs/release-notes.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
+
+
+SDC Workflow Designer Release Notes
+=============================
+
+Workflow Designer provides the ablitilty to design a bpmn workflow. It extends restful task and tosca task. so it can be combined with tosca template easily.
+
+
+
+Version: 1.0.0
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+
+* Support export workflow definition file;
+* Support basic workflow definition;
+
+
+**Bug Fixes**
+
+
+**Known Issues**
+
+**Security Issues**
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes