summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChrisC <christophe.closset@intl.att.com>2020-06-18 16:50:39 +0200
committerOfir Sonsino <ofir.sonsino@intl.att.com>2020-06-19 10:55:56 +0000
commit9ef860fe5e08f0d6ea82357c672ab11e5c0a4daa (patch)
tree1a4d16902aad7f5ff5067bbc38e4f1e37f576582 /docs
parent8420f17341541296448af7c61e11416e766d7216 (diff)
Fix more doc warnings
Fix couple of doc warnings Issue-ID: SDC-1357 Signed-off-by: ChrisC <christophe.closset@intl.att.com> Change-Id: I3c195ab8d9caacce7dde5d8e9631a0fb7c2ea25a
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.rst2
-rw-r--r--docs/genericdesignerintegration.rst6
-rw-r--r--docs/index.rst2
-rw-r--r--docs/logging.rst8
-rw-r--r--docs/offeredapis.rst8
-rw-r--r--docs/release-notes.rst8
6 files changed, 17 insertions, 17 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 3a17ac6c2d..ac897054a5 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -1,6 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. _architecture:
+.. _sdc_architecture:
================
SDC Architecture
diff --git a/docs/genericdesignerintegration.rst b/docs/genericdesignerintegration.rst
index a1b09f47db..0230a9b17e 100644
--- a/docs/genericdesignerintegration.rst
+++ b/docs/genericdesignerintegration.rst
@@ -1,12 +1,12 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-========
+============================
Generic Designer Integration
-========
+============================
Pluggable Architecture
-================================
+======================
SDC has been working on opening the application to allow an easy integration for any designer explanations.
The current definitions and explanations are located here:
diff --git a/docs/index.rst b/docs/index.rst
index 20e3816934..9353d96555 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,5 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. _master_index:
+.. _sdc_index:
SDC Documentation
=================
diff --git a/docs/logging.rst b/docs/logging.rst
index 53ed7aa86e..7475362df0 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -27,7 +27,7 @@ In the OOM deployment the log location in the docker is /var/log/onap
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
| | /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 releases. | rolls at 20 MB |
+| | /data/logs/BE/SDC/SDC-BE/transaction.log | application logging | Not currently in use, will be used in future releases. | 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. | |
@@ -41,13 +41,13 @@ In the OOM deployment the log location in the docker is /var/log/onap
+ +------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
| | /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 debugging, by editing the logback.xml inside the server docker.The file is located under: config/catalog-fe/logback.xml. | rolls |
+| | /data/logs/FE/SDC/SDC-FE/all.log | application logging | On demand we can enable log aggregation into one file for easier debugging, 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. | |
+-------------------------------+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
Changing log level
----------------------------
+------------------
SDC uses logback for logging.
In order to change the level you will need to access the docker.
Update the logback.xml inside the docker according to your need - the change does not require a restart of the docker.
@@ -79,7 +79,7 @@ Error / Warning Messages
------------------------
Response Types
-=============
+==============
::
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index e8846c913a..28d6f6dc29 100644
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -1,10 +1,10 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. _offeredapis:
+.. _sdcofferedapis:
-============
-Offered APIs
-============
+================
+SDC Offered APIs
+================
The list of APIs that SDC offers can be found from the following table:
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 898dc950cb..e0e3841eda 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,9 +1,9 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. _release_notes:
+.. _sdc_release_notes:
-=============
-Release Notes
-=============
+=================
+SDC Release Notes
+=================
Version: 1.6.6