diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-16 09:25:01 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-16 09:31:27 -0400 |
| commit | 4b00193d6ad8fcc99c5625ede8de07b72ae1c697 (patch) | |
| tree | 50834a826544ec43cacab94543b9e9d3411c46d5 /docs/onap-developer | |
| parent | 7fe52deb89467c1bb0e7f2a43f4092903b1d0021 (diff) | |
Update toctree to current release notes template
Change-Id: I0864d9e3c46aae885473a18fa21eab205a352eff
Issue-ID: SDC-419
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/onap-developer')
10 files changed, 0 insertions, 180 deletions
diff --git a/docs/onap-developer/docs-templates-platform-component-administration.rst b/docs/onap-developer/docs-templates-platform-component-administration.rst deleted file mode 100644 index 1d512cf020..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-administration.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - - -Administration --------------- -Describe expected changes and the processes and actions taken for each. - - -Processes -+++++++++ -* Process 1 -* Process 2 - -Actions -+++++++ -* Action X -* Action Y - diff --git a/docs/onap-developer/docs-templates-platform-component-architecture.rst b/docs/onap-developer/docs-templates-platform-component-architecture.rst deleted file mode 100644 index fd46637fd1..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-architecture.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. 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/onap-developer/docs-templates-platform-component-configuration.rst b/docs/onap-developer/docs-templates-platform-component-configuration.rst deleted file mode 100644 index c0c969f854..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-configuration.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Configuration -------------- -Describe configurations how to provide parameters and value - -Basic Setup -+++++++++++ - -You can provide the following in ``basic.conf`` - -``host=ADDRESS`` - The address of the host - -``port=PORT`` - The port used for signaling - - Optional. Default: ``8080`` diff --git a/docs/onap-developer/docs-templates-platform-component-consumedapis.rst b/docs/onap-developer/docs-templates-platform-component-consumedapis.rst deleted file mode 100644 index c4309cdb12..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-consumedapis.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Consumed APIs -============= -References to APIs offered by other components - - diff --git a/docs/onap-developer/docs-templates-platform-component-delivery.rst b/docs/onap-developer/docs-templates-platform-component-delivery.rst deleted file mode 100644 index cfcab0449b..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-delivery.rst +++ /dev/null @@ -1,31 +0,0 @@ -Delivery --------- -Describe how functions are packaged into run-time components. -For some components a block diagram may be useful. - -.. blockdiag:: - - - blockdiag layers { - orientation = portrait - a -> m; - b -> n; - c -> x; - m -> y; - m -> z; - group l1 { - color = blue; - x; y; z; - } - group l2 { - color = yellow; - m; n; - } - group l3 { - color = orange; - a; b; c; - } - - } - - diff --git a/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst b/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst deleted file mode 100644 index 03cc875edf..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. 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 -++++++ - - - - diff --git a/docs/onap-developer/docs-templates-platform-component-index.rst b/docs/onap-developer/docs-templates-platform-component-index.rst deleted file mode 100644 index d5db511f1e..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Platform Component -================== -Provide an overview of the ONAP Platform component capabilities here. -Add or remove sections below as appropriate for the platform component. - -.. toctree:: - :maxdepth: 1 - - architecture.rst - offeredapis.rst - consumedapis.rst - delivery.rst - logging.rst - installation.rst - configuration.rst - administration.rst - humaninterfaces.rst diff --git a/docs/onap-developer/docs-templates-platform-component-installation.rst b/docs/onap-developer/docs-templates-platform-component-installation.rst deleted file mode 100644 index 3238236c43..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-installation.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. 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/onap-developer/docs-templates-platform-component-logging.rst b/docs/onap-developer/docs-templates-platform-component-logging.rst deleted file mode 100644 index 8d480e2832..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-logging.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. 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/onap-developer/docs-templates-platform-component-offeredapis.rst b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst deleted file mode 100644 index 55e58bd9b3..0000000000 --- a/docs/onap-developer/docs-templates-platform-component-offeredapis.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. 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 |