diff options
Diffstat (limited to 'docs/onap-developer')
10 files changed, 180 insertions, 0 deletions
diff --git a/docs/onap-developer/docs-templates-platform-component-administration.rst b/docs/onap-developer/docs-templates-platform-component-administration.rst new file mode 100644 index 0000000000..1d512cf020 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-administration.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 + + +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 new file mode 100644 index 0000000000..fd46637fd1 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-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/onap-developer/docs-templates-platform-component-configuration.rst b/docs/onap-developer/docs-templates-platform-component-configuration.rst new file mode 100644 index 0000000000..c0c969f854 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-configuration.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 + +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 new file mode 100644 index 0000000000..c4309cdb12 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-consumedapis.rst @@ -0,0 +1,8 @@ +.. 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 new file mode 100644 index 0000000000..cfcab0449b --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-delivery.rst @@ -0,0 +1,31 @@ +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 new file mode 100644 index 0000000000..03cc875edf --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-humaninterfaces.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 + +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 new file mode 100644 index 0000000000..d5db511f1e --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-index.rst @@ -0,0 +1,20 @@ +.. 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 new file mode 100644 index 0000000000..3238236c43 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-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/onap-developer/docs-templates-platform-component-logging.rst b/docs/onap-developer/docs-templates-platform-component-logging.rst new file mode 100644 index 0000000000..8d480e2832 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-logging.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/onap-developer/docs-templates-platform-component-offeredapis.rst b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst new file mode 100644 index 0000000000..55e58bd9b3 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-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 |