Add README.md

README.md

@@ -0,0 +1,88 @@
+# Gate V1 Rollout – Analyse und Stabilisierung von CI-Artefakten
+
+## Überblick
+Das Experiment **gate_v1_rollout** zielt auf die Entwicklung eines Werkzeugs zur Analyse und Stabilisierung von CI-Artefakten, um den Rollout-Prozess der Gate-V1-Plattform zu verbessern.
+
+[Projektartikel](https://donau2space.de/tag-155-98-wolken-13-c-ich-fange-an-gate-v1-wirklich-rollout-faehig-zu-machen/)  
+[Git Repository](https://git.donau2space.de/Mika/gate_v1_rollout)
+
+## Hinweis
+Alle Inhalte wurden per KI generiert.  
+Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko.  
+Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
+
+## Inhalt des Repositories
+
+Das Repository umfasst folgende Artefakte:
+
+### 1. rollup_rollout
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python, CSV  
+- **Zweck:** Aggregation von CI-Ergebnissen in eine konsolidierte Rollout-Serie.
+
+**API-Funktionen:**
+- `generate_rollout_series(input_file: str, output_file: str)` – Erzeugt eine zusammengefasste Rollout-Serie aus den Eingabedaten.
+
+**Datentypen:**
+- `RolloutData` (JSON): Felder – policy_hash, outcome, unknown_rate, top_reasons
+
+### 2. unknown_whitelist
+- **Art:** json_dataset  
+- **Ziel:** linux-userspace  
+- **Sprachen:** JSON  
+- **Zweck:** Verwaltung einer Whitelist bekannter Unknown-Klassen zur Verbesserung der Fehlerbehandlung.
+
+**Datentypen:**
+- `UnknownWhitelistEntry` (JSON): Felder – entry, justification, scope
+
+### 3. rollout_series_report
+- **Art:** doc_only  
+- **Ziel:** mixed  
+- **Sprache:** Markdown  
+- **Zweck:** Dokumentation der Rollout-Serie und Präsentation der Ergebnisse in strukturierter Form.
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Python 3.9 oder höher
+- CSV-kompatible Datenquelle
+
+### Installation
+1. Repository klonen:
+   ```bash
+   git clone https://git.donau2space.de/Mika/gate_v1_rollout
+   cd gate_v1_rollout
+   ```
+2. Benötigte Abhängigkeiten installieren:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+### Nutzung
+Beispielaufruf zur Rollout-Generierung:
+```bash
+python rollup_rollout.py --input ./data/ci_results.csv --output ./out/rollout_series.json
+```
+
+### Ergebnis
+Die generierte Datei *rollout_series.json* enthält konsolidierte Kennwerte der CI-Ergebnisse und dient als Grundlage für Berichte und Analysen.
+
+## Typische Use-Cases
+- Erstellung von Rollout-Statistiken aus CI-Daten.
+- Fehlertoleranzanalyse mittels Whitelist bekannter Unknown-Klassen.
+- Generierung verständlicher Report-Dokumentation für Projektteams.
+
+## Struktur & Erweiterbarkeit
+- `rollup_rollout.py` – Kernskript zur Aggregation der Daten.  
+- `data/unknown_whitelist.json` – Datensatz der bekannten Unbekannten.  
+- `doc/rollout_series_report.md` – Zusammenfassende Berichterstattung.
+
+Zukünftige Erweiterungen können zusätzliche Metriken, Visualisierungen oder Integrationen mit CI/CD-Systemen betreffen. Die bestehenden Python-Funktionen sind offen für Modulimport und Weiterverarbeitung.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+---
+
+*Die Inhalte wurden automatisiert generiert. Nutzung auf eigenes Risiko.*