added repository and UI information in guide

CERN · Nov 15, 2024 · 9c876aa · 9c876aa
1 parent 880783a
commit 9c876aa
Show file tree

Hide file tree

Showing 15 changed files with 809 additions and 523 deletions.
diff --git a/caimira/docs/mkdocs/docs/LICENSE.md b/caimira/docs/mkdocs/docs/LICENSE.md
@@ -0,0 +1,13 @@
+Copyright 2020-2021 CERN. All rights not expressly granted are reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/caimira/docs/mkdocs/docs/code_documentation/index.md b/caimira/docs/mkdocs/docs/code_documentation/index.md
diff --git a/caimira/docs/mkdocs/docs/code_documentation/rest_api.md b/caimira/docs/mkdocs/docs/code_documentation/rest_api.md
@@ -210,16 +210,15 @@ The deployment process varies depending on whether changes are pushed to branche
 ### Branch and Tag-based Deployment
 
 For branch pushes:
+
 * All branches (except `live/caimira-test`) trigger the **test** stage in the CI/CD pipeline, ensuring the code passes all necessary tests before it is deployed.
 
 For tag creation:
+
 * When a new tag is created, the pipeline skips the previous tests, and it builds `Docker` images, storing them in GitLab's container registry. The images can be manually deployed to the OKD platform for the `PROD` - production environment.
 
 ### OKD Platform Deployment
 The `cern_caimira` package, which contains the CERN-specific UI, is deployed directly to the OKD platform. The `caimira package`, which contains the backend logic, is deployed as a standalone API for integration with external services.
 
 ### Versioning and Tags
 The repository follows a *semantic versioning* scheme, with tags named according to the `MAJOR.MINOR.PATCH` format (e.g., `v5.0.0`).
-
-
-<!--     * It defines two report handlers for CO2 and virus report generation (`CO2ReportHandler` and `VirusReportHandler`) with the respective routes (`/co2_report` and `/virus_report`). By default the server listens on port `8088`. -->
diff --git a/caimira/docs/mkdocs/docs/index.md b/caimira/docs/mkdocs/docs/index.md
@@ -6,13 +6,17 @@ It includes details on the diameter-dependent mathematical model and the code de
 
 # Contents:
 
-* [Project Overview](project_overview.md)
-
-* [Diameter-dependent Model](full_diameter_dependence.md)
-
-* [Code-related Documentation](code_documentation/index.md)
-
-    * [CAiMIRA REST API](code_documentation/rest_api.md)
-    * [CAiMIRA Models](code_documentation/models.md)
-
-* [Open Source Acknowledgments](open_source_acknowledgments.md)
+* [Project Overview]()
+    * [About](project_overview/about.md)
+    * [Installation](project_overview/installation.md)
+    * [Deployment](project_overview/deployment.md)
+    * [User Guide]()
+        * [Quick Guide](project_overview/user_guide/quick_guide.md)
+        * [Full Guide](project_overview/user_guide/full_guide.md)
+    * [Open Source Acknowledgments](project_overview/open_source_acknowledgments.md)
+
+* [Code Documentation]()
+    * [Overview](code_documentation/overview.md)
+    * [Diameter Normalization](code_documentation/diameter_normalization.md)
+    * [REST API](code_documentation/rest_api.md)
+    * [Models Module](code_documentation/models.md)