Add the document file for esr-server.

[aai/esr-server.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..f101744
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+AAI-esr-server
+------------------------------------------------
+
+ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. esr-server as the backend of exteral system register service mainly include the system register information preprocessing, system available check. 
+
+ESR comprises two modules: the esr server module and the esr gui module. And both esr service and esr gui belongs A&AI.
+
+- AAI
+    - ESR server Module
+    - ESR gui Module
+
+.. toctree::
+   :maxdepth: 1
+   
+   offeredapis.rst
+
+