diff options
| author |   Ildiko Vancsa <ildiko.vancsa@ericsson.com> | 2016-01-11 22:40:44 +0100 |
|---|---|---|
| committer | Ildiko Vancsa <ildiko.vancsa@ericsson.com> | 2016-01-14 07:45:08 +0100 |
| commit | e4f39a6ccdd98547c0b84abf399b97dbdc2afa23 (patch) | |
| tree | 42dfc8b3a3aaba8251efd84d7e29d8fee1a4dabc | |
| parent | 89d72ce042b455a51df30224af99221ba89c64c0 (diff) | |
Add user documentation for Promise
Add the following guides to document Promise:
* Platform overview
* User guide
* Install and configuration guide
Change-Id: I3d2c05cf41c8c58f22cba2a3340d87fe78a67749
| -rw-r--r-- | docs/configguide/featureconfig.rst | 5 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 9 | ||||
| -rw-r--r-- | docs/platformoverview/index.rst | 9 | ||||
| -rw-r--r-- | docs/platformoverview/promise_platform.rst | 15 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 9 | ||||
| -rw-r--r-- | docs/userguide/userguide.rst | 5 |
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. |