summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorIldiko Vancsa <ildiko.vancsa@ericsson.com>2016-01-11 22:40:44 +0100
committerGerald Kunzmann <kunzmann@docomolab-euro.com>2016-01-29 09:51:13 +0000
commit50cf7f1864b20dad2c21b3e4ce0ca5be379d0177 (patch)
tree69ae62d5c7f57c21de2ef259625d95ed6e4f7ceb /docs
parent1d1a4703e5ad4c6cef0ffc4053f965f0cd25116f (diff)
Add user documentation for Promise
Add the following guides to document Promise: * Platform overview * User guide * Install and configuration guide Change-Id: I3d2c05cf41c8c58f22cba2a3340d87fe78a67749 (cherry picked from commit e4f39a6ccdd98547c0b84abf399b97dbdc2afa23)
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/featureconfig.rst5
-rw-r--r--docs/configguide/index.rst9
-rw-r--r--docs/platformoverview/index.rst9
-rw-r--r--docs/platformoverview/promise_platform.rst15
-rw-r--r--docs/userguide/index.rst9
-rw-r--r--docs/userguide/userguide.rst5
6 files changed, 52 insertions, 0 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644
index 0000000..44e7a3a
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -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
index 0000000..88bb1a2
--- /dev/null
+++ b/docs/configguide/index.rst
@@ -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
index 0000000..aa926dc
--- /dev/null
+++ b/docs/platformoverview/index.rst
@@ -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
index 0000000..0dd3cb9
--- /dev/null
+++ b/docs/platformoverview/promise_platform.rst
@@ -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
index 0000000..0000aa6
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -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
index 0000000..e337adf
--- /dev/null
+++ b/docs/userguide/userguide.rst
@@ -0,0 +1,5 @@
+==================
+Promise User Guide
+==================
+
+Promise user guide documentation.