Seminararbeit DevOps & CI/CD (#486)

Co-authored-by: Sebastian <94404394+SeZett@users.noreply.github.com>
Co-authored-by: Tristan Nolde <tristan.nolde@yahoo.de>

.gitignore

@@ -243,3 +243,4 @@ secrets*.json
 *.db
 remote.json
 requirements.txt
+/documentations/seminararbeiten/DevOps/seminararbeit/dev-ops.pdf

README.md

@@ -1,13 +1,5 @@
 # aki_prj23_transparenzregister
 
-[![python](https://img.shields.io/badge/Python-3.11-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
-[![Actions status](https://github.com/astral-sh/ruff/workflows/CI/badge.svg)](https://github.com/astral-sh/ruff/actions)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
-[![Documentation Status](https://readthedocs.org/projects/mypy/badge/?version=stable)](https://mypy.readthedocs.io/en/stable/?badge=stable)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
 ## Contributions
 
 See the [CONTRIBUTING.md](CONTRIBUTING.md) about how code should be formatted and what kind of rules we set ourselves.
@@ -53,7 +45,7 @@ The sqlite db is alternative to the postgres section.
 Alternatively, the secrets can be provided as environment variables. One option to do so is to add a `.env` file with
 the following layout:
 
-```
+```dotenv
 PYTHON_POSTGRES_USERNAME=postgres
 PYTHON_POSTGRES_PASSWORD=postgres
 PYTHON_POSTGRES_HOST=postgres
@@ -66,12 +58,14 @@ PYTHON_MONGO_PASSWORD=password
 PYTHON_MONGO_PORT=27017
 PYTHON_MONGO_DATABASE=transparenzregister
 
-PYTHON_SQLITE_PATH=PathToSQLite3.db # An overwrite path to an sqllite db
+# An overwrite path to an sqlite db
+PYTHON_SQLITE_PATH=PathToSQLite3.db
 
 PYTHON_DASH_LOGIN_USERNAME=some-login-to-webgui
 PYTHON_DASH_LOGIN_PW=some-pw-to-login-to-webgui
 
-PYTHON_INGEST_SCHEDULE=12 # Every x hours
+# Every x hours
+PYTHON_INGEST_SCHEDULE=12
 
 CR=ghcr.io/fhswf/aki_prj23_transparenzregister
 TAG=latest

documentations/Ergebnisse/Zwischenbericht_und_Praesentation/PhHo/prompts.md

@@ -0,0 +1,11 @@
+Bitte überarbeite den folgenden Text.
+Halte dich inhaltlich an die Vorgaben.
+Korrigiere aber bitte, Grammatik, Zeichensetzung und Stil.
+Bitte kürze / teile die Sätze wenn möglich.
+
+
+Bitte gib mir die überarbeitete version in Markdown (md) aus.
+Dieses sollte in einem md codeblock angezeigt werden.
+
+Bitte fange für jeden Satz eine neue Zeile an.
+Sollten Fragen offen bleiben schreibe mir bitte einen kurzen Verweise auf den md block.

documentations/index.rst

@@ -38,7 +38,7 @@ Diese sind, um Industriestandards zu entsprechen, auf Englisch gehalten.
    :caption: Seminararbeiten
    :numbered:
 
-   seminararbeiten/DevOps/Seminarpraesentation.ipynb
+   Ergebnisse/Zwischenbericht_und_Praesentation/PhHo/dev-ops
    seminararbeiten/Datenspeicherung/00_Datenspeicherung
 
 .. toctree::
@@ -50,13 +50,6 @@ Diese sind, um Industriestandards zu entsprechen, auf Englisch gehalten.
    Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/4-4-2-database-generator
 
 
-.. .. toctree::
-   :glob:
-   :maxdepth: 1
-   :caption: UI Mock Ups
-
-.. mock_up/**/*
-
 .. toctree::
    :glob:
    :maxdepth: 1