diff options
author | Rich Bennett <rb2745@att.com> | 2017-10-10 07:39:06 -0400 |
---|---|---|
committer | Rich Bennett <rb2745@att.com> | 2017-10-10 07:44:50 -0400 |
commit | 7134cba7aa509a5ee7628244c52979e02807d252 (patch) | |
tree | 01d4f737b6c3b27515bd8f116850f838b7cc6830 /docs/templates/platform-component | |
parent | 2f3328219820a4be426981282350034b21e2e3f3 (diff) |
Improve templates and add references in guides
See description of DOC-101
Added multipple conf.py files to test themes and multiple versions
Created initial structure for references in developer architecture guide and release notes
Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693
Issue-ID: DOC-101
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/platform-component')
-rw-r--r-- | docs/templates/platform-component/administration.rst | 19 | ||||
-rw-r--r-- | docs/templates/platform-component/architecture.rst | 7 | ||||
-rw-r--r-- | docs/templates/platform-component/configuration.rst | 19 | ||||
-rw-r--r-- | docs/templates/platform-component/consumedapis.rst | 8 | ||||
-rw-r--r-- | docs/templates/platform-component/delivery.rst | 31 | ||||
-rw-r--r-- | docs/templates/platform-component/humaninterfaces.rst | 19 | ||||
-rw-r--r-- | docs/templates/platform-component/index.rst | 20 | ||||
-rw-r--r-- | docs/templates/platform-component/installation.rst | 14 | ||||
-rw-r--r-- | docs/templates/platform-component/logging.rst | 14 | ||||
-rw-r--r-- | docs/templates/platform-component/offeredapis.rst | 29 |
10 files changed, 0 insertions, 180 deletions
diff --git a/docs/templates/platform-component/administration.rst b/docs/templates/platform-component/administration.rst deleted file mode 100644 index 1d512cf02..000000000 --- a/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/templates/platform-component/architecture.rst b/docs/templates/platform-component/architecture.rst deleted file mode 100644 index fd46637fd..000000000 --- a/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/templates/platform-component/configuration.rst b/docs/templates/platform-component/configuration.rst deleted file mode 100644 index c0c969f85..000000000 --- a/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/templates/platform-component/consumedapis.rst b/docs/templates/platform-component/consumedapis.rst deleted file mode 100644 index c4309cdb1..000000000 --- a/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/templates/platform-component/delivery.rst b/docs/templates/platform-component/delivery.rst deleted file mode 100644 index cfcab0449..000000000 --- a/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/templates/platform-component/humaninterfaces.rst b/docs/templates/platform-component/humaninterfaces.rst deleted file mode 100644 index 03cc875ed..000000000 --- a/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/templates/platform-component/index.rst b/docs/templates/platform-component/index.rst deleted file mode 100644 index d5db511f1..000000000 --- a/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/templates/platform-component/installation.rst b/docs/templates/platform-component/installation.rst deleted file mode 100644 index 3238236c4..000000000 --- a/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/templates/platform-component/logging.rst b/docs/templates/platform-component/logging.rst deleted file mode 100644 index 8d480e283..000000000 --- a/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/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst deleted file mode 100644 index 55e58bd9b..000000000 --- a/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 |