From 5ed4e8533a28ae96755a091ae16aa5fd4bea5150 Mon Sep 17 00:00:00 2001 From: Pamela Dragosh Date: Fri, 22 Sep 2017 12:26:16 -0400 Subject: Adding documentation placeholders Starting point for policy engine documentation Issue-ID: POLICY-190 Change-Id: I165bc9c709523e2b76890e6b8acd0b0c2a40625a Signed-off-by: Pamela Dragosh --- docs/index.rst | 5 +++-- docs/platform/architecture.rst | 7 +++++++ docs/platform/index.rst | 12 ++++++++++++ docs/platform/installation.rst | 14 ++++++++++++++ docs/platform/offeredapis.rst | 29 +++++++++++++++++++++++++++++ docs/platform/policygui.rst | 19 +++++++++++++++++++ docs/release-notes/bug-fixes.rst | 5 +++++ docs/release-notes/deprecation-notes.rst | 5 +++++ docs/release-notes/index.rst | 15 +++++++++++++++ docs/release-notes/known-issues.rst | 5 +++++ docs/release-notes/new-features.rst | 5 +++++ docs/release-notes/other.rst | 5 +++++ docs/release-notes/security-issues.rst | 5 +++++ docs/release-notes/upgrade-notes.rst | 5 +++++ 14 files changed, 134 insertions(+), 2 deletions(-) create mode 100644 docs/platform/architecture.rst create mode 100644 docs/platform/index.rst create mode 100644 docs/platform/installation.rst create mode 100644 docs/platform/offeredapis.rst create mode 100644 docs/platform/policygui.rst create mode 100644 docs/release-notes/bug-fixes.rst create mode 100644 docs/release-notes/deprecation-notes.rst create mode 100644 docs/release-notes/index.rst create mode 100644 docs/release-notes/known-issues.rst create mode 100644 docs/release-notes/new-features.rst create mode 100644 docs/release-notes/other.rst create mode 100644 docs/release-notes/security-issues.rst create mode 100644 docs/release-notes/upgrade-notes.rst diff --git a/docs/index.rst b/docs/index.rst index 4df15fc8d..f3d2bdb79 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,6 +4,7 @@ Policy Engine ------------- .. toctree:: - :maxdepth: 1 - + :maxdepth: 2 + platform/index + release-notes/index 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 ``_ + + +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 +++++++ + + + + diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst new file mode 100644 index 000000000..ee4ff9faf --- /dev/null +++ b/docs/release-notes/bug-fixes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Bug Fixes +--------- + diff --git a/docs/release-notes/deprecation-notes.rst b/docs/release-notes/deprecation-notes.rst new file mode 100644 index 000000000..e954e8764 --- /dev/null +++ b/docs/release-notes/deprecation-notes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Deprecation Notes +----------------- + diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst new file mode 100644 index 000000000..adc76f935 --- /dev/null +++ b/docs/release-notes/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. toctree:: + :maxdepth: 2 + + new-features.rst + bug-fixes.rst + known-issues.rst + security-issues.rst + upgrade-notes.rst + deprecation-notes.rst + other.rst diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst new file mode 100644 index 000000000..01c93d124 --- /dev/null +++ b/docs/release-notes/known-issues.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Known Issues +------------ + diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst new file mode 100644 index 000000000..ab86bb949 --- /dev/null +++ b/docs/release-notes/new-features.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +New Features +------------ + diff --git a/docs/release-notes/other.rst b/docs/release-notes/other.rst new file mode 100644 index 000000000..2ce683b5b --- /dev/null +++ b/docs/release-notes/other.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Other +----- + diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst new file mode 100644 index 000000000..96e1fe95e --- /dev/null +++ b/docs/release-notes/security-issues.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Security Issues +--------------- + diff --git a/docs/release-notes/upgrade-notes.rst b/docs/release-notes/upgrade-notes.rst new file mode 100644 index 000000000..f31c74a69 --- /dev/null +++ b/docs/release-notes/upgrade-notes.rst @@ -0,0 +1,5 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Upgrade Notes +------------- + -- cgit 1.2.3-korg