Add user documentation for Promise 47/8447/1
authorIldiko Vancsa <ildiko.vancsa@ericsson.com>
Mon, 11 Jan 2016 21:40:44 +0000 (22:40 +0100)
committerGerald Kunzmann <kunzmann@docomolab-euro.com>
Fri, 29 Jan 2016 09:51:13 +0000 (09:51 +0000)
Add the following guides to document Promise:

* Platform overview
* User guide
* Install and configuration guide

Change-Id: I3d2c05cf41c8c58f22cba2a3340d87fe78a67749
(cherry picked from commit e4f39a6ccdd98547c0b84abf399b97dbdc2afa23)

docs/configguide/featureconfig.rst [new file with mode: 0644]
docs/configguide/index.rst [new file with mode: 0644]
docs/platformoverview/index.rst [new file with mode: 0644]
docs/platformoverview/promise_platform.rst [new file with mode: 0644]
docs/userguide/index.rst [new file with mode: 0644]
docs/userguide/userguide.rst [new file with mode: 0644]

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644 (file)
index 0000000..44e7a3a
--- /dev/null
@@ -0,0 +1,5 @@
+======================================
+Promise Feature Configuration Overview
+======================================
+
+Overview of Promise configuration.
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
new file mode 100644 (file)
index 0000000..88bb1a2
--- /dev/null
@@ -0,0 +1,9 @@
+********************************************
+Promise Installation and Configuration Guide
+********************************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   featureconfig.rst
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
new file mode 100644 (file)
index 0000000..aa926dc
--- /dev/null
@@ -0,0 +1,9 @@
+****************************
+Overview of Promise Platform
+****************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   promise_platform.rst
diff --git a/docs/platformoverview/promise_platform.rst b/docs/platformoverview/promise_platform.rst
new file mode 100644 (file)
index 0000000..0dd3cb9
--- /dev/null
@@ -0,0 +1,15 @@
+=========================
+Promise Platform Overview
+=========================
+
+https://wiki.opnfv.org/promise
+
+Features
+========
+
+Description of platform capabilities
+
+Components
+==========
+
+Describe the platform architecture
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644 (file)
index 0000000..0000aa6
--- /dev/null
@@ -0,0 +1,9 @@
+******************
+Promise User Guide
+******************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   userguide.rst
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
new file mode 100644 (file)
index 0000000..e337adf
--- /dev/null
@@ -0,0 +1,5 @@
+==================
+Promise User Guide
+==================
+
+Promise user guide documentation.