Überarbeitung webIDE
Dokumentationsseiten (Pflichtfeld)
-
Neue Dokumentationsseite -
Bestehende Dokumentationsseite (Link:webIDE ) anpassen
User Story
Verbesserung der Fehlererkennung in der WebIDE für MDX-Dateien
Beim Arbeiten mit der WebIDE treten häufig kleine Fehler in MDX-Dateien auf, wie z. B. ein zusätzliches ' oder ein fehlendes _.
Diese führen oft erst beim Build-Prozess zu Fehlermeldungen, sodass Entwickler:innen mühsam Strings vergleichen und Error-Logs durchsehen müssen, um die Ursache zu finden.
Durch die Nutzung von WebIDE-Extensions kann dieser Prozess stark vereinfacht werden.
Mit Erweiterungen wie MDX Preview oder Syntaxprüfungen lassen sich viele Fehler schon direkt im Editor erkennen.
Warum?
Entwickler:innen sollen Fehler in MDX-Dateien frühzeitig erkennen können, um aufwendige Fehlersuchen nach fehlgeschlagenen Builds zu vermeiden.
Die Dokumentation beschreibt, wie Administrator:innen die Nutzung von WebIDE-Extensions ermöglichen und welche Erweiterungen sich für FIT-Connect eignen.
Vorgehensweise
-
Extensions in der WebIDE aktivieren
- Admins können in der WebIDE die Installation von Extensions erlauben.
- So lassen sich zusätzliche Werkzeuge wie Syntaxprüfungen oder Vorschau-Tools integrieren.
-
Empfohlene Extensions installieren
- MDX Preview: Zeigt MDX-Dateien direkt in der WebIDE an.
- Syntax Checker / Linter: Markiert fehlende Zeichen, Tippfehler oder Formatierungsprobleme sofort.
-
Fehler frühzeitig erkennen
- Entwickler:innen sehen potenzielle Probleme direkt im Editor.
- Das reduziert fehlerhafte Builds und verkürzt Debugging-Zeiten.
Vorteile
- Früherkennung von Fehlern: Kein mühsames Vergleichen von Strings und Logs mehr.
- Schnellerer Workflow: Reduziert die Zeit bis zur erfolgreichen Dokumentationserstellung.
- Bessere Code-Qualität: Weniger Build-Abbrüche durch triviale Syntaxfehler.
Weitere Hinweise
- Definition of Done
- Optionale Ergänzung: Integration von Linting-Checks in den CI/CD-Prozess zur zusätzlichen Absicherung.
Ansprechpartner
- Zuständige PO: wird ergänzt
- Technische Ansprechperson: wird ergänzt
Akzeptanzkriterien
-
Die Dokumentation erklärt, wie Admins Extensions aktivieren können. -
Mindestens eine empfohlene Extension (MDX Preview) wird dokumentiert. -
Entwickler:innen können durch die Dokumentation eigenständig Fehler frühzeitig erkennen.