consolidate to development (#148)

SE-TINF22B2 · Apr 30, 2024 · 23edb79 · 23edb79
1 parent f55b906
commit 23edb79
Show file tree

Hide file tree

Showing 19 changed files with 20 additions and 32 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -7,9 +7,8 @@ export default withMermaid({
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Projekt', link: '/project/idea' },
-      { text: 'Statusberichte', link: '/reports/reports'},
-      { text: 'Guidelines', link: '/guidelines/project-guideline' },
-      { text: 'Development', link: '/development/overview',  }
+      { text: 'Statusberichte', link: '/reports/reports' },
+      { text: 'Development', link: '/development/project-guideline' }
     ],
 
     sidebar: {
@@ -43,32 +42,21 @@ export default withMermaid({
         }
       ],
 
-      '/guidelines/': [
+      '/development': [
+        { text: "Project Guideline", link: "/development/project-guideline" },
+        { text: "API", link: "/development/api" },
         {
-          text: 'Guidelines',
-          items: [
-            { text: 'Project Guideline', link: '/guidelines/project-guideline' },
-            { text: 'API', link: '/guidelines/api' },
-            { text: 'Backend Guideline', link: '/guidelines/backend' },
-            { text: 'Frontend Guideline', link: '/guidelines/frontend' }
+          text: "Backend", link: "/development/backend/overview", items: [
+            { text: 'Authentication', link: '/development/backend/authentication' },
+            { text: 'Logging', link: '/development/backend/logging' },
+            { text: 'Testing', link: '/development/backend/testing' },
           ]
-        }
-      ],
-      '/development': [
-        { 
-          text: 'Configuration & Standards', 
-          items: [
-            { text: 'Authentication', link: '/development/authentication' },
-            { text: 'Logging', link: '/development/logging' },
-          ] 
         },
         {
-          text: 'Testing',
-          items: [
-            { text: 'Backend', link: '/development/testing/backend' },
-            { text: 'Frontend', link: '/development/testing/frontend' }
+          text: "Frontend", link: "/development/frontend/overview", items: [
+            { text: 'Testing', link: '/development/frontend/testing' },
           ]
-        }
+        },
       ]
     },
 

diff --git a/docs/guidelines/api.md → docs/development/api.md b/docs/guidelines/api.md → docs/development/api.md
@@ -50,4 +50,3 @@ Es gibt Protokolle die auf dem REST-Protokoll aufbauen und dieses um weitere Fun
 ## API Spezifikation
 
 Unsere aktuelle API Spezifikation findet sich <a href="/api/client.html">hier</a>.
-
diff --git a/docs/development/authentication.md → docs/development/backend/authentication.md b/docs/development/authentication.md → docs/development/backend/authentication.md
@@ -1,13 +1,17 @@
 # Authentication
+
 > [!WARNING]
 > The currently used authentication mechanism is subject to changes and only intended for development purposes.
+
 ## Local Authentication (Development)
+
 During development `Basic`-Authentication is enabled to make authentication easier. You need to supply a username and a password.
 There are example users available, when using the database seeds.
 
 ### Example Users
+
 The password for all available example users is
 `1234`.
 Please note that those users are not available in production.
 
-- `[email protected]`: Max Mustermann
+- `[email protected]`: Max Mustermann
diff --git a/docs/development/logging.md → docs/development/backend/logging.md b/docs/development/logging.md → docs/development/backend/logging.md
diff --git a/docs/guidelines/backend.md → docs/development/backend/overview.md b/docs/guidelines/backend.md → docs/development/backend/overview.md
diff --git a/docs/development/testing/backend.md → docs/development/backend/testing.md b/docs/development/testing/backend.md → docs/development/backend/testing.md
diff --git a/docs/guidelines/frontend.md → docs/development/frontend/overview.md b/docs/guidelines/frontend.md → docs/development/frontend/overview.md
@@ -34,11 +34,11 @@ Das Frontend folgt dem Atomic Design-Prinzip, das die Website-Komponenten in ver
 
 Zusätzlich sollten separate Ordner für Services, Pipes usw. sowie für die E2E-Tests angelegt werden.
 
-## Technolgien
+## Technologien
 
 Für die Entwicklung des Frontends wurde die Auswahl zwischen zwei Frameworks in Betracht gezogen: React und Angular. Obwohl React während einer Vorlesung behandelt wurde, konnten keine weiteren Erfahrungen damit gesammelt werden . Im Gegensatz dazu wurde Angular während der praktischen Phase intensiver verwendet, was zu einem besseren Verständnis dieses Frameworks führte. Daher wurde Angular als das Framework für das Projekt ausgewählt.
 
-## Richtlinine
+## Richtlinien
 
 ### Branches
 

diff --git a/docs/development/testing/frontend.md → docs/development/frontend/testing.md b/docs/development/testing/frontend.md → docs/development/frontend/testing.md
@@ -1,4 +1,4 @@
-# Frontend
+# Testing
 
 ## Introduction
 

diff --git a/docs/development/overview.md b/docs/development/overview.md
diff --git a/docs/guidelines/project-guideline.md → docs/development/project-guideline.md b/docs/guidelines/project-guideline.md → docs/development/project-guideline.md
diff --git a/docs/guidelines/timetracking/.example.env → docs/project/timetracking/.example.env b/docs/guidelines/timetracking/.example.env → docs/project/timetracking/.example.env
diff --git a/docs/guidelines/timetracking/data/KW15.csv → docs/project/timetracking/data/KW15.csv b/docs/guidelines/timetracking/data/KW15.csv → docs/project/timetracking/data/KW15.csv
diff --git a/docs/guidelines/timetracking/data/KW16.csv → docs/project/timetracking/data/KW16.csv b/docs/guidelines/timetracking/data/KW16.csv → docs/project/timetracking/data/KW16.csv
diff --git a/docs/guidelines/timetracking/data/KW17.csv → docs/project/timetracking/data/KW17.csv b/docs/guidelines/timetracking/data/KW17.csv → docs/project/timetracking/data/KW17.csv
diff --git a/...uidelines/timetracking/generate_charts.py → docs/project/timetracking/generate_charts.py b/...uidelines/timetracking/generate_charts.py → docs/project/timetracking/generate_charts.py
diff --git a/docs/guidelines/timetracking/get_data.sh → docs/project/timetracking/get_data.sh b/docs/guidelines/timetracking/get_data.sh → docs/project/timetracking/get_data.sh
diff --git a/...idelines/timetracking/statistics/KW15.png → .../project/timetracking/statistics/KW15.png b/...idelines/timetracking/statistics/KW15.png → .../project/timetracking/statistics/KW15.png
diff --git a/...idelines/timetracking/statistics/KW16.png → .../project/timetracking/statistics/KW16.png b/...idelines/timetracking/statistics/KW16.png → .../project/timetracking/statistics/KW16.png
diff --git a/...idelines/timetracking/statistics/KW17.png → .../project/timetracking/statistics/KW17.png b/...idelines/timetracking/statistics/KW17.png → .../project/timetracking/statistics/KW17.png