Navigation aus Docusaurus-Unterseiten zur Landing Page [XS] -> [S]

Warum?

Als Nutzer:in des Entwicklungsportals möchte ich von Docusaurus-Unterseiten (z.B. docs.fitko.de/fit-connect/) zurück zur Landingpage des Entwicklungsportals (docs.fitko.de) navigieren können.

Relevante Links und Bemerkungen

Akzeptanzkriterien

1. Auf allen bestehenden Doku-Seiten (FIT-Connect, DVDV, FIM-XÖV, Payment API, Standards und Schnittstellen, ...) findet sich ein identisch gestalteter Link zur Landingpage des Entwicklungsportals. Folgende GitLab-Projekte müssen angepasst werden:
   • https://git.fitko.de/dvdv/docs/ (leer)
   • https://git.fitko.de/foederale-it/fim-xoev/fim-xoev-doc
   • https://git.fitko.de/fit-connect/docs/
   • https://git.fitko.de/foederale-it/payment-api
   • https://git.fitko.de/pvog/docs (leer)
   • https://git.fitko.de/ag-standards-und-schnittstellen/standards-und-schnittstellen
2. Die Anpassung ist auch im docusaurus-template umgesetzt.
3. Das Docs-Logo (extrahierter FITKO Schriftzug) ist entfernt.

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

• ...
• ...
• ...
• Definition of Done wurde geprüft

added component::Docusaurus component::Entwicklungsportal type::Story workflow::Ready for Refinement labels

changed title from Navigation aus Docusaurus-Unterseiten zur Landing Page to Navigation aus Docusaurus-Unterseiten zur Landing Page [XS]

added workflow::Ready label and removed workflow::Ready for Refinement label

assigned to @Mark_Kane

removed workflow::Ready label

added workflow::In Progress label

mentioned in commit docusaurus-template@ae5c78e2

changed the description

changed the description

changed title from Navigation aus Docusaurus-Unterseiten zur Landing Page [XS] to Navigation aus Docusaurus-Unterseiten zur Landing Page [XS] -> [S]

changed the description

mentioned in commit docs@fe70792c

mentioned in commit docusaurus-template@45a177ca

mentioned in commit docs@da02f6f5

mentioned in merge request docusaurus-template!1 (merged)

Hi @Marco_Holz , wir haben hier leider ein Problem für den Moment. Ich habe das ganze noch mal ausführlich mit @Rene_Roesner analysiert (danke René) und wir haben festgestellt, dass Docusaurus zwischen den Versionen 2.0.0-beta.18 und 2.0.0-beta.19 offenbar einen Breaking-change enthält (aktuell und mein Stand ist 2.0.0-beta.20), der in unserer komplexeren Konfiguration im Fit-Connect-Dokuportal zu Fehlern im Production-build führt.

Trotz intensiver Recherche und Debugging-Versuche habe ich die konkrete Ursache dafür noch nicht herausfinden können. Allerdings sind in einem Github-Issue von Docusaurus heute andere Personen mit dem gleichen Problem aufgetaucht und die Entwickler scheinen sich dem Thema anzunehmen:

• https://github.com/facebook/docusaurus/issues/7398
• https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/79

In den anderen bisher von mir getesteten Repositories (docusaurus-template, fim-xoev-doc und dvdv-docs) funktionieren Button + Upgrade auf 2.0.0-beta.20 problemlos. Ich würde also in diesen Repos gerne weiter so verfahren.

Leider funktionieren genau die Features mit denen ich den Button eingebaut habe erst ab 2.0.0-beta.19. Alternative Lösungsansätze gibt es naturlich mehrere, gleichzeitig müssen wir sowieso irgendwann Docusaurus auch in der Fit-Connect-Doku updaten. Im Prinzip sehe ich diese Optionen:

1. Wir trennen das Update und den Back Button komplett und ich baue eine alternative Implementierung des Back-Buttons, die mit unserem alten beta.13 funktioniert. Ein Update machen wir ein anderes mal.
2. Wir machen das Update auf 2.0.0-beta.18, das René und ich als möglich getestet haben. Dort baue ich dann eine alternative Implementierung des Back-Buttons ein.
3. Wir warten etwas ab und beobachten die obigen Issues, ggf. gebe ich dort Feedback bzgl. unseres Problems. Sollte sich eine Lösung abzeichnen übernehmen wir die und bleiben bei der Implementierung des Buttons wie gehabt, nur etwas verzögert.

Was meinst du @Marco_Holz?

Kleines Update: in dem Issue gibt es mitlerweise die Erkenntnis, dass das Problem in Verbindung mit OpenAPI Plugins aufzutreten scheint. Für "redocusaurus" gibt es inzwischen einen externen Fix. Wir verwenden allerdings das Modul "RapiDoc".

Lass uns da mal gemeinsam drüber sprechen. Danke für die Zusammenfassung!

Weiteres Update: bin auf Github in Kontakt und habe mitlwerweile mit Feedback eines Entwicklers einen Weg gefunden das Portal in 2.0.0-beta.20 ohne Fehler zu builden. Leider nicht für die Pipeline, da der Fix eine lokale Änderung in einer @docusaurus core-lib Datei beinhaltet. Aber immerhin ein Fortschritt der auf ein Patch oder anderen Workaround hoffen lässt.

added workflow::Blocked label

Update @Marco_Holz: nach längerem Austausch mit den Entwicklern im verlinkten Issue ist ein Problem in einer Docusaurus Core Library gefunden und behoben worden. Mit dem entsprechenden Canary-Build läuft das Projekt wieder. Vor dem langen Wochenende gab es noch kein offizielles Release von Docusaurus, doch nun ist die 2.0.0-beta.21 released worden ... hoffentlich MIT dem Bugfix. Ich prüfe das heute.

mentioned in commit docs@08a60768