aboutsummaryrefslogtreecommitdiffstats
path: root/docs/onap-developer
diff options
context:
space:
mode:
authorIdan Amit <ia096e@intl.att.com>2017-10-17 10:07:57 +0300
committerIdan Amit <ia096e@intl.att.com>2017-10-17 10:07:57 +0300
commitde8975b0ae93fce227d798d9847a238938306cf6 (patch)
tree864f6c50b2b3c9ba19840b655d2fb90e836cccf1 /docs/onap-developer
parent93d9cc0a99f82a828a93012338f7eff3b271f7cb (diff)
Update docs to current release template
Merged changes from master branch into release-1.1.0 branch Added logs table from the wiki to the logging page of the docs Change-Id: Id2eda18edd00441c01f399d1feb9f162c011f797 Issue-ID: SDC-419 Signed-off-by: Idan Amit <ia096e@intl.att.com>
Diffstat (limited to 'docs/onap-developer')
-rw-r--r--docs/onap-developer/docs-templates-platform-component-administration.rst19
-rw-r--r--docs/onap-developer/docs-templates-platform-component-architecture.rst7
-rw-r--r--docs/onap-developer/docs-templates-platform-component-configuration.rst19
-rw-r--r--docs/onap-developer/docs-templates-platform-component-consumedapis.rst8
-rw-r--r--docs/onap-developer/docs-templates-platform-component-delivery.rst31
-rw-r--r--docs/onap-developer/docs-templates-platform-component-humaninterfaces.rst19
-rw-r--r--docs/onap-developer/docs-templates-platform-component-index.rst20
-rw-r--r--docs/onap-developer/docs-templates-platform-component-installation.rst14
-rw-r--r--docs/onap-developer/docs-templates-platform-component-logging.rst38
-rw-r--r--docs/onap-developer/docs-templates-platform-component-offeredapis.rst29
10 files changed, 0 insertions, 204 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 eed1568d2b..0000000000
--- a/docs/onap-developer/docs-templates-platform-component-logging.rst
+++ /dev/null
@@ -1,38 +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 on how to interact with and diagnose problems with the components as delivered.
-
-+--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| Server | Location | Type | Description | Rolling |
-+--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| BE | /data/logs/BE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding Jetty startup and execution | the log rolls daily |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/audit.log | application audit | An audit record is created for each operation in SDC | rolls at 20 mb |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb |
-| | | | The file is located under:,config/catalog-be/logback.xml. | |
-| | | | This log holds the debug and trace level output of the application. | |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 mb |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use. will be used in future relases. | rolls at 20 mb |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/BE/SDC/SDC-BE/all.log | application logging | On demand, we can enable log aggregation into one file for easier debugging. This is done by editing the logback.xml inside the server docker. | rolls at 20 mb |
-| | | | The file is located under:,config/catalog-be/logback.xml. | |
-| | | | To allow this logger, set the value for this property to true This log holds all logging output of the application. | |
-+--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| FE | /data/logs/FE/2017_03_10.stderrout.log | Jetty server log | The log describes info regarding the Jetty startup and execution | the log rolls daily |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb |
-| | | | The file is located,under: config/catalog-fe/logback.xml. | |
-| | | | This log holds the debug and trace level output of the application. | |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/error.log | application logging | This log holds the Info and Error level output of the application. | rolls at 20 mb |
-+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
-| | /data/logs/FE/SDC/SDC-FE/all.log | application logging | On demand we can enable log aggregation into one file for easier debuging, by editing the logback.xml inside the server docker.The file is located under: config/catalog-fe/logback.xml. | rolls |
-| | | | To allow this logger set this property to true | |
-| | | | This log holds all the logging output of the application. | |
-+--------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ \ No newline at end of file
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