Draft: Resolve "Automatisierte Spellcheck für die Dokumentation mit CI/CD automatisieren"

What is new and why?

Zuerst !24 mergen! (Branch ist von dort entstanden, nicht vom aktuellen main).

Dieser MR fügt eine automatisierte Rechtschreibprüfung mit cspell durch. Änderungen sind:

  • Dockerfile.cspell baut Image für cspell
  • CI angepasst, sodass Image automatisiert gebaut werden. Es werden jetzt zwei Images gebaut( (für mkdocs und cspell, daher waren die Änderungen an dem CI Job, der die Images baut, etwas umfangreicher). Muss noch getestet werden, wenn Lizenzchecks okay sind!
  • cspell Konfiguration (cspell.yml für Konfiguration und cspell-dict.txt für eigenes Dictionairy
  • Makefile enthält jetzt docker-cspell command mit dem Image gebaut werden kann und cspell lokal getestet werden kann

TODO

  • Automatisierten check in der CI einbauen
  • Lizenzcheck von cspell (CC @fka)
  • Umgang mit Findings (siehe unten)

Aktuelle Findings:

docs/docs/build.md:9:87 - Unknown word (gecloned)
docs/docs/build.md:35:26 - Unknown word (Clonen)
docs/docs/build.md:37:96 - Unknown word (gecloned)
docs/docs/build.md:51:75 - Unknown word (gecloned)
docs/docs/quickstart.md:6:27 - Unknown word (gecloned)
docs/index.md:61:16 - Unknown word (Kontakdaten)
docs/javascripts/extra.js:12:36 - Unknown word (matomo)
docs/kennenlernen/charakteristika.md:19:3 - Unknown word (Datenschutzfreundlicher)
docs/kennenlernen/geschichte.md:9:30 - Unknown word (Prototypprojekt)
docs/kennenlernen/geschichte.md:9:60 - Unknown word (Inno)
docs/kennenlernen/geschichte.md:12:15 - Unknown word (Prototypprojekts)
docs/kennenlernen/index.md:50:56 - Unknown word (Softwarearchitketur)
docs/kennenlernen/index.md:58:56 - Unknown word (Sicherheitsarchitketur)
docs/kennenlernen/roadmap.md:23:25 - Unknown word (Transkriptionstool)
docs/kennenlernen/roadmap.md:25:7 - Unknown word (Featurebeschreibung)
docs/kennenlernen/roadmap.md:31:116 - Unknown word (Transkriptionsaufgaben)
docs/kennenlernen/roadmap.md:42:36 - Unknown word (Transkriptionstools)
docs/kennenlernen/roadmap.md:44:7 - Unknown word (Featurebeschreibung)
docs/kennenlernen/roadmap.md:58:9 - Unknown word (Transkriptions)
docs/kennenlernen/roadmap.md:63:7 - Unknown word (Featurebeschreibung)
docs/kennenlernen/roadmap.md:84:7 - Unknown word (Featurebeschreibung)
docs/kennenlernen/roadmap.md:96:68 - Unknown word (Inno)
docs/kennenlernen/roadmap.md:104:7 - Unknown word (Featurebeschreibung)
docs/kennenlernen/roadmap.md:115:5 - Unknown word (Inno)
docs/kennenlernen/roadmap.md:125:55 - Unknown word (Anfragetypen)
docs/kennenlernen/roadmap.md:125:73 - Unknown word (intuitivere)
docs/kennenlernen/roadmap.md:125:149 - Unknown word (softwarearchitektonische)
docs/kennenlernen/roadmap.md:134:5 - Unknown word (Inno)
docs/kennenlernen/roadmap.md:140:78 - Unknown word (multimodalen)
docs/kennenlernen/roadmap.md:152:5 - Unknown word (Inno)
docs/kennenlernen/roadmap.md:172:5 - Unknown word (Inno)
docs/kennenlernen/roadmap.md:221:17 - Unknown word (whitegelabeltes)
docs/kennenlernen/roadmap.md:221:55 - Unknown word (whitegelabelte)
docs/kennenlernen/roadmap.md:230:5 - Unknown word (Innolab)
docs/kennenlernen/roadmap.md:249:34 - Unknown word (Barrierefreiheitsvorgaben)
docs/kennenlernen/sicherheitsarchitektur.md:8:173 - Unknown word (Infrastrukturumgebung)
docs/kennenlernen/sicherheitsarchitektur.md:39:37 - Unknown word (Transformationsregeln)
docs/kennenlernen/sicherheitsarchitektur.md:42:18 - Unknown word (Lebenszyklusmanagement)
docs/kennenlernen/sicherheitsarchitektur.md:46:20 - Unknown word (Invalidierung)
docs/kennenlernen/sicherheitsarchitektur.md:59:50 - Unknown word (Ratenbegrenzung)
docs/kennenlernen/softwarearchitektur.md:16:39 - Unknown word (Authentifzierung)
docs/kennenlernen/softwarearchitektur.md:22:92 - Unknown word (Inferencing)
docs/kennenlernen/softwarearchitektur.md:31:24 - Unknown word (whitegelabelt)
docs/kennenlernen/softwarearchitektur.md:46:184 - Unknown word (Bildgenerierungs)
docs/kennenlernen/softwarearchitektur.md:50:5 - Unknown word (Feedbackdatenbank)
docs/kennenlernen/softwarearchitektur.md:52:104 - Unknown word (Feedbackdatenbank)
docs/kontakt/impressum.md:10:1 - Unknown word (Inno)
docs/mitmachen/code-of-conduct.md:48:63 - Unknown word (transphobe)
docs/mitmachen/code-of-conduct.md:75:106 - Unknown word (Unported)
docs/mitmachen/contributing-guidelines.md:29:4 - Unknown word (Verbessungswünsche)
docs/mitmachen/contributing-guidelines.md:68:13 - Unknown word (Überarbeitungs)
docs/mitmachen/contributing-guidelines.md:68:34 - Unknown word (Klärungsbedarfe)
docs/mitmachen/contributing-guidelines.md:69:61 - Unknown word (Hauptbranch)
docs/mitmachen/contributing-guidelines.md:87:67 - Unknown word (eigesetzte)
docs/mitmachen/contributing-guidelines.md:99:26 - Unknown word (Bezeichnungsschema)
docs/mitmachen/contributing-guidelines.md:104:113 - Unknown word (Rückwärtskompatibilität)
docs/mitmachen/contributing-guidelines.md:145:92 - Unknown word (reviewenden)
docs/mitmachen/lizenzchecks.md:7:46 - Unknown word (Roolkit)
docs/nutzen/compliance.md:32:32 - Unknown word (DSFA)
docs/nutzen/compliance.md:47:3 - Unknown word (Maßnahmenplanung)
docs/nutzen/compliance.md:53:9 - Unknown word (Anwendungsscope)
docs/nutzen/deployment-checkliste.md:16:14 - Unknown word (Orchestrierungsumgebung)
docs/nutzen/deployment-checkliste.md:29:65 - Unknown word (jina)
docs/nutzen/deployment-checkliste.md:34:59 - Unknown word (jina)
docs/nutzen/deployment-checkliste.md:38:55 - Unknown word (Adminrechte)
docs/nutzen/deployment-checkliste.md:63:74 - Unknown word (Supportprozess)
docs/nutzen/deployment.md:2:14 - Unknown word (kubernetes)
docs/nutzen/deployment.md:5:11 - Unknown word (kubernetes)
docs/nutzen/deployment.md:108:161 - Unknown word (Buildschritt)
docs/nutzen/deployment.md:129:72 - Unknown word (nginx)
docs/nutzen/deployment.md:443:160 - Unknown word (Buildschritt)
docs/nutzen/index.md:9:32 - Unknown word (Schulungsmateralien)
docs/nutzen/index.md:25:13 - Unknown word (kubernetes)
docs/nutzen/index.md:29:56 - Unknown word (deployen)
docs/nutzen/index.md:54:23 - Unknown word (enstpricht)
docs/nutzen/releases.md:9:227 - Unknown word (getaggt)
docs/nutzen/releases.md:9:425 - Unknown word (Komponententests)
faq.yml:150:29 - Unknown word (Tokenisierung)
faq.yml:159:9 - Unknown word (Diskriminierungsfreiheit)
faq.yml:233:22 - Unknown word (ollama)
includes/abbreviations.md:35:52 - Unknown word (Referenzierungssystem)
includes/abbreviations.md:53:136 - Unknown word (lizenzbehaftete)
includes/abbreviations.md:73:61 - Unknown word (versionierte)

Related issues

Closes #7

Author's TODOs

  • Merge latest version of target branch (e.g., main) into your branch
  • Check if SPDX identifier MPL-2.0 and Copyright-Text 2025 Land Baden-Württemberg <InnoLab@stm.bwl.de> exists in newly created files and/or hasn't been deleted or modified in existing files
  • If necessary: Adapted the README.md
  • If necessary: Adapted the documentation (https://f13-os.de/)

Reviewer's TODOs

  • Check if the Author did their checks well enough
  • Try if the cause of the issue is solved as intended

To keep in mind

  • pre-commit used
  • Added logging output where necessary
  • Added/adjusted error handling to avoid unwanted crashes and make proper debugging and testing possible
Edited by Lennart de Vries

Merge request reports

Loading