From 2651834d547e3b788f498f7cb865d05cd56c9ef9 Mon Sep 17 00:00:00 2001
From: Christos Tranoris <tranoris@gmail.com>
Date: Mon, 1 Jul 2024 17:31:48 +0300
Subject: [PATCH] draft structure

---
 doc/config_intro.md      |  0
 doc/deployment.md        | 20 +-------------------
 doc/deploymentCompose.md |  2 ++
 doc/deploymentK8s.md     |  2 ++
 doc/index.md             |  4 ++--
 doc/terminology.md       |  3 +++
 mkdocs.yml               | 20 +++++++++++++-------
 7 files changed, 23 insertions(+), 28 deletions(-)
 create mode 100644 doc/config_intro.md
 create mode 100644 doc/terminology.md

diff --git a/doc/config_intro.md b/doc/config_intro.md
new file mode 100644
index 00000000..e69de29b
diff --git a/doc/deployment.md b/doc/deployment.md
index 2336a261..e2a495a6 100644
--- a/doc/deployment.md
+++ b/doc/deployment.md
@@ -2,25 +2,7 @@
 
 This section is meant to guide the user through the installation of OpenSlice. 
 
-## Hardware requirements
-
-The complete environment consists of microservices deployed as docker containers. Portainer is also installed to monitor them at port 9000.
-
-If you would like to operate all APIs, OSOM, the Mysql Server, nginx, etc then you need at least:
-
-| **Minimum Hardware Requirements** | **Recomended Hardware Requirements** |
-| --------------------------------- | ------------------------------------ |
-| 4 CPU cores                       | 8 CPU cores                          |
-| 8 GB RAM                          | 16 GB RAM                            |
-| 20 GB storage                     | 40 GB storage                        |
-
-
-(NOTE: Bugzilla or ELK are not included and we assume they run elsewhere)
-
-However, you may try the front facing services of OpenSlice with a minimum installation on a VM on a laptop with:
-
-- 2 cores
-- 4GB of RAM  
+## Intended Audience: OpenSlice administrators
 
 Following, you may thorough guides depending on the installation type of your choice:
 
diff --git a/doc/deploymentCompose.md b/doc/deploymentCompose.md
index b65614c5..622c67f7 100644
--- a/doc/deploymentCompose.md
+++ b/doc/deploymentCompose.md
@@ -1,5 +1,7 @@
 # OpenSlice Deployment Guide with Docker Compose
 
+## Intended Audience: OpenSlice administrators
+
 ## Requirements
 
 ### Hardware requirements:
diff --git a/doc/deploymentK8s.md b/doc/deploymentK8s.md
index 2a0e9636..1d8e4353 100644
--- a/doc/deploymentK8s.md
+++ b/doc/deploymentK8s.md
@@ -1,5 +1,7 @@
 # OpenSlice Deployment Guide with Kubernetes 
 
+## Intended Audience: OpenSlice administrators
+
 This is WIP.
 
 Please refer to this [guide](https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/blob/2024Q2_RC/kubernetes/helm/README.md).
\ No newline at end of file
diff --git a/doc/index.md b/doc/index.md
index b792f783..2f6dbf43 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -90,8 +90,8 @@ Check a live demo of OpenSlice in the following pages:
 
 * The NFV portal part of OpenSlice was initially developed in H2020 European Research project [5GinFIRE](https://5ginfire.eu) by University of Patras, Greece
 * OpenSlice core services, APIs was further developed and maintained in H2020 European project [5G-VINNI](https://5g-vinni.eu/) by University of Patras, Greece
-* OpenSlice has been a part off OSM's OSS/BSS ecosystem
-* OpenSlice is now an ETSI SDG Gropup since 2023
+* OpenSlice has been a part of OSM's OSS/BSS ecosystem
+* OpenSlice is now an ETSI SDG Group since 2023
 
 
 ## Citation
diff --git a/doc/terminology.md b/doc/terminology.md
new file mode 100644
index 00000000..5e1e9de1
--- /dev/null
+++ b/doc/terminology.md
@@ -0,0 +1,3 @@
+OpenSlice management cluster
+OpenSlice administrator
+Service Designer
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 19f56650..3e1a4907 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -76,13 +76,19 @@ nav:
           - Introduction: deployment.md
           - Docker Compose: deploymentCompose.md
           - Kubernetes: deploymentK8s.md
-      - NFV Orchestrator Configuration: nfvoconfig.md
-      - Service Catalogs: catalogs.md
-      - NFV Catalogs: nfvcatalogs.md
-      - LCM Rules: lcm.md
-      - Consuming Services From External OSS: ./architecture/consumingServicesFromExternalPartners.md
-      - Service Inventory: service_inventory.md
-      - Alarms and Actions: alarms_actions.md
+      - Configuration: config_intro.md
+          - NFV Orchestrator Configuration: nfvoconfig.md
+      - Service design:
+          - Introduction: service_design_intro.md
+          - Service Catalogs: catalogs.md
+          - NFV Catalogs: nfvcatalogs.md
+          - LCM Rules: lcm.md      
+      - Service Ordering:
+        - Service Inventory: service_inventory.md
+      - OpenSlice management:
+        - Consuming Services From External OSS: ./architecture/consumingServicesFromExternalPartners.md
+        - Alarms and Actions: alarms_actions.md
+      - Terminology: terminology.md
   - Design & Architecture:
       - Architecture: ./architecture/architecture.md
       - Message bus: ./architecture/messagebus.md
-- 
GitLab