summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDylanB95EST <dylan.byrne@est.tech>2021-09-22 10:38:21 +0100
committerDylanB95EST <dylan.byrne@est.tech>2021-09-22 14:59:11 +0100
commit7c94323078c1db1973117defa94ddcde414a323f (patch)
tree95b7d700cc6b80197f7add4e058a2d408428b611
parent8f254ba0f91be28ffdba801d03a7493d94bdc0b8 (diff)
Update preliminary documentation CPS-Core with Admin Guide
Add Admin Guide Page with Logging & Diagnostics section to preliminary documentation for Istanbul releas Issue-ID: CPS-676 Change-Id: Ie2ca89cca225ffc692eaf7ebc5880b92801062a1 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
-rw-r--r--docs/admin-guide.rst18
-rwxr-xr-xdocs/index.rst1
-rw-r--r--docs/requirements-docs.txt2
3 files changed, 20 insertions, 1 deletions
diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
new file mode 100644
index 0000000000..8e917e1f51
--- /dev/null
+++ b/docs/admin-guide.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix Foundation
+
+.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
+.. _adminGuide:
+
+
+CPS Admin Guide
+###############
+
+.. warning:: draft
+
+.. toctree::
+ :maxdepth: 1
+
+Logging & Diagnostics
+=====================
diff --git a/docs/index.rst b/docs/index.rst
index ec2ec5dd88..265887414a 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,6 +18,7 @@ CPS-Core Documentation
overview.rst
architecture.rst
+ admin-guide.rst
design.rst
modeling.rst
deployment.rst
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index b3188ddd38..a743c226a7 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,5 +1,5 @@
tox
-Sphinx
+Sphinx==4.2.0
doc8
docutils
setuptools