From: Ildiko Vancsa Date: Mon, 11 Jan 2016 21:40:44 +0000 (+0100) Subject: Add user documentation for Promise X-Git-Tag: brahmaputra.1.0~9 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=50cf7f1864b20dad2c21b3e4ce0ca5be379d0177;p=promise.git 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) --- 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.