From 23edb79747afbd481f5d18709edc9f6d5eae748f Mon Sep 17 00:00:00 2001 From: Benedict Weis <47110382+benedictweis@users.noreply.github.com> Date: Tue, 30 Apr 2024 12:48:43 +0200 Subject: [PATCH] consolidate to development (#148) --- docs/.vitepress/config.mts | 36 ++++++------------ docs/{guidelines => development}/api.md | 1 - .../{ => backend}/authentication.md | 6 ++- docs/development/{ => backend}/logging.md | 0 .../backend/overview.md} | 0 .../backend.md => backend/testing.md} | 0 .../frontend/overview.md} | 4 +- .../frontend.md => frontend/testing.md} | 2 +- docs/development/overview.md | 3 -- .../project-guideline.md | 0 .../timetracking/.example.env | 0 .../timetracking/data/KW15.csv | 0 .../timetracking/data/KW16.csv | 0 .../timetracking/data/KW17.csv | 0 .../timetracking/generate_charts.py | 0 .../timetracking/get_data.sh | 0 .../timetracking/statistics/KW15.png | Bin .../timetracking/statistics/KW16.png | Bin .../timetracking/statistics/KW17.png | Bin 19 files changed, 20 insertions(+), 32 deletions(-) rename docs/{guidelines => development}/api.md (99%) rename docs/development/{ => backend}/authentication.md (92%) rename docs/development/{ => backend}/logging.md (100%) rename docs/{guidelines/backend.md => development/backend/overview.md} (100%) rename docs/development/{testing/backend.md => backend/testing.md} (100%) rename docs/{guidelines/frontend.md => development/frontend/overview.md} (98%) rename docs/development/{testing/frontend.md => frontend/testing.md} (99%) delete mode 100644 docs/development/overview.md rename docs/{guidelines => development}/project-guideline.md (100%) rename docs/{guidelines => project}/timetracking/.example.env (100%) rename docs/{guidelines => project}/timetracking/data/KW15.csv (100%) rename docs/{guidelines => project}/timetracking/data/KW16.csv (100%) rename docs/{guidelines => project}/timetracking/data/KW17.csv (100%) rename docs/{guidelines => project}/timetracking/generate_charts.py (100%) rename docs/{guidelines => project}/timetracking/get_data.sh (100%) rename docs/{guidelines => project}/timetracking/statistics/KW15.png (100%) rename docs/{guidelines => project}/timetracking/statistics/KW16.png (100%) rename docs/{guidelines => project}/timetracking/statistics/KW17.png (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 2d99ce5..009185e 100644 --- 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 b/docs/development/api.md similarity index 99% rename from docs/guidelines/api.md rename to docs/development/api.md index cd2e42a..6d32f61 100644 --- a/docs/guidelines/api.md +++ b/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 hier. - diff --git a/docs/development/authentication.md b/docs/development/backend/authentication.md similarity index 92% rename from docs/development/authentication.md rename to docs/development/backend/authentication.md index ad808a7..e9dd64f 100644 --- a/docs/development/authentication.md +++ b/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. -- `max@example.org`: Max Mustermann \ No newline at end of file +- `max@example.org`: Max Mustermann diff --git a/docs/development/logging.md b/docs/development/backend/logging.md similarity index 100% rename from docs/development/logging.md rename to docs/development/backend/logging.md diff --git a/docs/guidelines/backend.md b/docs/development/backend/overview.md similarity index 100% rename from docs/guidelines/backend.md rename to docs/development/backend/overview.md diff --git a/docs/development/testing/backend.md b/docs/development/backend/testing.md similarity index 100% rename from docs/development/testing/backend.md rename to docs/development/backend/testing.md diff --git a/docs/guidelines/frontend.md b/docs/development/frontend/overview.md similarity index 98% rename from docs/guidelines/frontend.md rename to docs/development/frontend/overview.md index 90e182d..4b87eb1 100644 --- a/docs/guidelines/frontend.md +++ b/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 b/docs/development/frontend/testing.md similarity index 99% rename from docs/development/testing/frontend.md rename to docs/development/frontend/testing.md index 7c42dc0..d9132e6 100644 --- a/docs/development/testing/frontend.md +++ b/docs/development/frontend/testing.md @@ -1,4 +1,4 @@ -# Frontend +# Testing ## Introduction diff --git a/docs/development/overview.md b/docs/development/overview.md deleted file mode 100644 index bd38581..0000000 --- a/docs/development/overview.md +++ /dev/null @@ -1,3 +0,0 @@ -# Development -> [!WARNING] -> This section is subject to change as it's intended to document the development process. This is not intented for an external audience. \ No newline at end of file diff --git a/docs/guidelines/project-guideline.md b/docs/development/project-guideline.md similarity index 100% rename from docs/guidelines/project-guideline.md rename to docs/development/project-guideline.md diff --git a/docs/guidelines/timetracking/.example.env b/docs/project/timetracking/.example.env similarity index 100% rename from docs/guidelines/timetracking/.example.env rename to docs/project/timetracking/.example.env diff --git a/docs/guidelines/timetracking/data/KW15.csv b/docs/project/timetracking/data/KW15.csv similarity index 100% rename from docs/guidelines/timetracking/data/KW15.csv rename to docs/project/timetracking/data/KW15.csv diff --git a/docs/guidelines/timetracking/data/KW16.csv b/docs/project/timetracking/data/KW16.csv similarity index 100% rename from docs/guidelines/timetracking/data/KW16.csv rename to docs/project/timetracking/data/KW16.csv diff --git a/docs/guidelines/timetracking/data/KW17.csv b/docs/project/timetracking/data/KW17.csv similarity index 100% rename from docs/guidelines/timetracking/data/KW17.csv rename to docs/project/timetracking/data/KW17.csv diff --git a/docs/guidelines/timetracking/generate_charts.py b/docs/project/timetracking/generate_charts.py similarity index 100% rename from docs/guidelines/timetracking/generate_charts.py rename to docs/project/timetracking/generate_charts.py diff --git a/docs/guidelines/timetracking/get_data.sh b/docs/project/timetracking/get_data.sh similarity index 100% rename from docs/guidelines/timetracking/get_data.sh rename to docs/project/timetracking/get_data.sh diff --git a/docs/guidelines/timetracking/statistics/KW15.png b/docs/project/timetracking/statistics/KW15.png similarity index 100% rename from docs/guidelines/timetracking/statistics/KW15.png rename to docs/project/timetracking/statistics/KW15.png diff --git a/docs/guidelines/timetracking/statistics/KW16.png b/docs/project/timetracking/statistics/KW16.png similarity index 100% rename from docs/guidelines/timetracking/statistics/KW16.png rename to docs/project/timetracking/statistics/KW16.png diff --git a/docs/guidelines/timetracking/statistics/KW17.png b/docs/project/timetracking/statistics/KW17.png similarity index 100% rename from docs/guidelines/timetracking/statistics/KW17.png rename to docs/project/timetracking/statistics/KW17.png