Automatische Verlinkungen auf das Glossar
Warum?
Um Fachbegriffe in der Dokumentation einfacher verständlich zu machen, sollen diese automatisch durch einen Link auf das Glossar erklärt werden.
Relevante Links und Bemerkungen
siehe z.B. https://gitlab.grnet.gr/terminology/docusaurus-terminology
Folgende GitLab-Projekte müssen angepasst werden: siehe https://git.fitko.de/fit-connect/docusaurus-template/-/wikis/home
Akzeptanzkriterien
-
Docusaurus Terminology Plugin wurde in einem Merge Request evaluiert (limitiert auf 4 Stunden) -
weiteres Vorgehen in der PO Sprechstunde abklären -
Plugin ist in template-Repo und in https://git.fitko.de/foederale-it/fim-xoev-doc eingebunden -
NEU: Im template-Repo gibt es eine kurze Beschreibung in der Readme
Out of Scope
- Begriffe werden nicht automatisch migriert (wird in einem separatem Ticket behandelt)
Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)
-
Plugin herunterladen -
Prüfen ob Kompatibilität mit aktueller Docusaurus Version gegeben ist. -
Evaluierung ob innerhalb von 4 Stunden eine Lösung für ein Glossarwort realisiert werden konnte -
Glossary-Funktion testen -
Falls Ja / Nein, sollte die Lösung in der PO Sprechstunde besprochen werden. -
Definition of Done wurde geprüft
Edited by Marco Holz