diff options
| author |   Pamela Dragosh <pdragosh@research.att.com> | 2017-09-22 12:26:16 -0400 |
|---|---|---|
| committer | Pamela Dragosh <pdragosh@research.att.com> | 2017-09-22 12:32:08 -0400 |
| commit | 5ed4e8533a28ae96755a091ae16aa5fd4bea5150 (patch) | |
| tree | 80733212b63b0a71ee8ccff89a75e9ed487fc0a5 /docs/platform | |
| parent | 86c16d34a2b8fa0d0c30dfe32ecb8ec04abc391b (diff) | |
Adding documentation placeholders
Starting point for policy engine documentation
Issue-ID: POLICY-190
Change-Id: I165bc9c709523e2b76890e6b8acd0b0c2a40625a
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'docs/platform')
| -rw-r--r-- | docs/platform/architecture.rst | 7 | ||||
| -rw-r--r-- | docs/platform/index.rst | 12 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 14 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst | 29 | ||||
| -rw-r--r-- | docs/platform/policygui.rst | 19 |
5 files changed, 81 insertions, 0 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst new file mode 100644 index 000000000..fd46637fd --- /dev/null +++ b/docs/platform/architecture.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Architecture +------------ +Describe the architecture and design of the platform component. diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 000000000..b489b2fb3 --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Policy Engine +------------- + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + installation.rst + policygui.rst diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst new file mode 100644 index 000000000..3238236c4 --- /dev/null +++ b/docs/platform/installation.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +------------ +Describe the environment and steps to install. + + +Environment ++++++++++++ + + +Steps ++++++ diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst new file mode 100644 index 000000000..55e58bd9b --- /dev/null +++ b/docs/platform/offeredapis.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Offered APIs +============ +List APIs offered. One or more of the following examples may be appropriate. + +Example Swagger Displayed with swaggerv2doc directive +----------------------------------------------------- + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json + + +Example documenting a REST interface with Sphinx httpdomain directive +--------------------------------------------------------------------- + +.. http:get:: path + + For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_ + + +Word Document Converted to RST using Pandocs +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide diff --git a/docs/platform/policygui.rst b/docs/platform/policygui.rst new file mode 100644 index 000000000..3d95579a7 --- /dev/null +++ b/docs/platform/policygui.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Policy GUI +---------------- +Provide info on the targeted user, interface types, ports/protocols to access, etc. + +Target Users +++++++++++++ + +Interface Type +++++++++++++++ + +Access +++++++ + + + + |