diff options
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/platform/administration.rst | 15 | ||||
| -rw-r--r-- | docs/platform/architecture.rst | 7 | ||||
| -rw-r--r-- | docs/platform/configuration.rst | 8 | ||||
| -rw-r--r-- | docs/platform/consumedapis.rst | 7 | ||||
| -rw-r--r-- | docs/platform/delivery.rst | 9 | ||||
| -rw-r--r-- | docs/platform/human-interfaces.rst | 15 | ||||
| -rw-r--r-- | docs/platform/index.rst | 19 | ||||
| -rw-r--r-- | docs/platform/installation.rst (renamed from docs/installation.rst) | 2 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 14 | ||||
| -rw-r--r-- | docs/platform/offeredapis.rst (renamed from docs/offeredapis.rst) | 2 | ||||
| -rw-r--r-- | docs/release-notes/bug-fixes.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/index.rst | 15 | ||||
| -rw-r--r-- | docs/release-notes/known-issues.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/new-features.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/security-issues.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes/upgrade-notes.rst | 4 |
17 files changed, 133 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst index 7b01229..61fadd1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,6 @@ ESR comprises two modules: the esr server module and the esr gui module. And bot .. toctree:: :maxdepth: 1 - offeredapis.rst - installation.rst + platform/index.rst + release-notes/index.rst diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst new file mode 100644 index 0000000..5213df7 --- /dev/null +++ b/docs/platform/administration.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Administration +-------------- + +Processes +^^^^^^^^^ +* Process 1 +* Process 2 + +Actions +^^^^^^^ +* Action X +* Action Y diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst new file mode 100644 index 0000000..18d38b0 --- /dev/null +++ b/docs/platform/architecture.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Architecture +------------ + + diff --git a/docs/platform/configuration.rst b/docs/platform/configuration.rst new file mode 100644 index 0000000..cedb443 --- /dev/null +++ b/docs/platform/configuration.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Configuration +------------- + +No machanism for customized configurtions is provided in the Amsterdam release. Such functionalities will be provided in the future if necessary. + diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst new file mode 100644 index 0000000..5124ec4 --- /dev/null +++ b/docs/platform/consumedapis.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 + +Consumed APIs +------------- + +In the Amsterdam release, Holmes does not consume any APIs provided by other ONAP components. diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst new file mode 100644 index 0000000..27b3770 --- /dev/null +++ b/docs/platform/delivery.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Delivery +-------- + +Describe how functions are packaged into run-time components. For some components a block diagram may be useful. + +**TO BE DONE**
\ No newline at end of file diff --git a/docs/platform/human-interfaces.rst b/docs/platform/human-interfaces.rst new file mode 100644 index 0000000..e8501d0 --- /dev/null +++ b/docs/platform/human-interfaces.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +---------------- +Provide info on the targeted user, interface types, ports/protocols to access, etc. + +Target Users +^^^^^^^^^^^^ + +Interface Type +^^^^^^^^^^^^^^ + +Access +^^^^^^
\ No newline at end of file diff --git a/docs/platform/index.rst b/docs/platform/index.rst new file mode 100644 index 0000000..244820f --- /dev/null +++ b/docs/platform/index.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Platform +-------- + +ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. + +.. toctree:: + :maxdepth: 1 + + architecture.rst + offeredapis.rst + consumedapis.rst + delivery.rst + log-and-diagnostic-info.rst + installation.rst + configuration.rst + administration.rst + human-interfaces.rst diff --git a/docs/installation.rst b/docs/platform/installation.rst index 25da181..93a658c 100644 --- a/docs/installation.rst +++ b/docs/platform/installation.rst @@ -3,4 +3,4 @@ Installation ------------ -- `ESR setup <https://wiki.onap.org/display/DW/ESR+setup>`_.
\ No newline at end of file +- `ESR setup <https://wiki.onap.org/display/DW/ESR+setup>`_. diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst new file mode 100644 index 0000000..4bda4ba --- /dev/null +++ b/docs/platform/log-and-diagnostic-info.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 + +Logging & Diagnostic Information +--------------------------------- + +Description of how to interact with and diagnose problems with the components as delivered. + +Where to Access Information +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Error / Warning Messages +^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/offeredapis.rst b/docs/platform/offeredapis.rst index a792f3c..bfbf999 100644 --- a/docs/offeredapis.rst +++ b/docs/platform/offeredapis.rst @@ -19,4 +19,4 @@ The esr server module provides the following APIs. * thirdparty SDNC update * thirdparty SDNC Deletion -- `ESR APIs <https://wiki.onap.org/pages/viewpage.action?pageId=11930343>`_. +- `ESR APIs <https://wiki.onap.org/pages/viewpage.action?pageId=11930343>`_.
\ No newline at end of file diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst new file mode 100644 index 0000000..4dc09fc --- /dev/null +++ b/docs/release-notes/bug-fixes.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Bug Fixes +--------- diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst new file mode 100644 index 0000000..0ca2ea8 --- /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 +------------- + +ESR provide a way to register external system which not included in ONAP system, mainly inclouded VIM/VNFM/EMS/thirdparty SDNC. + +.. toctree:: + :maxdepth: 1 + + new-features.rst + bug-fixes.rst + upgrade-notes.rst + security-issues.rst + known-issues.rst diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst new file mode 100644 index 0000000..f4341d7 --- /dev/null +++ b/docs/release-notes/known-issues.rst @@ -0,0 +1,4 @@ +.. 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 0000000..f548910 --- /dev/null +++ b/docs/release-notes/new-features.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +New Features +------------ diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst new file mode 100644 index 0000000..3a6cd9e --- /dev/null +++ b/docs/release-notes/security-issues.rst @@ -0,0 +1,4 @@ +.. 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 0000000..29e67e5 --- /dev/null +++ b/docs/release-notes/upgrade-notes.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Upgrade Notes +------------- |