Dokumentation der Nutzung des Java-SDK auf docs.fitko.de

Warum?

Sobald das Java-SDK in der Version 1.0.0. verfügbar ist, soll die Dokumentation beschreiben, wie Software-Entwickler:innen damit arbeiten können.

Relevante Links und Bemerkungen

Zu klären

  1. Welche Inhalte finden sich in der Doku, welche in der Readme der SDKs.

Akzeptanzkriterien

  1. Im Dropdown-Menü "SDKs" wird das Java-SDK ergänzt.
  2. Auf der übersichtsseite zu den SDKs finde sich ein Link auf die Unterseite zum Java-SDK.
  3. Das Java-SDK ist auf Maven Central verfügbar. In der Dokumentation (oder der Readme des Java-SDK?) ist beschrieben, wie Software-Entwickler das Package in ihre Projekte einbinden.
  4. Das Maven-Central-Paket ist verlinkt.
  5. Ein Verweis auf das Quellcode-Repo des Java-SDK ist vorhanden.
  6. Aussage vorhanden, dass das Java-SDK ab der Version 1.0.0 für den produktiven Einsatz genutzt werden kann.
  7. Es ist beschrieben, welche Java-Version das SDK mindestens voraussetzt.
  8. .NET: Doku der addReplyChannels-Methode
  9. Aktualisierung Beispielwerte (z.B. Leika-Schlüssel und Leistungsname) - Dieser Punkt wird im Issue #1064 umgesetzt (wird für die 1.0.X eingeplant)

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

  • Die Datei 'docusaurus.config.js' geändert, um den neuen Menüpunkt 'SDKs' in die horizontale Navigation einzufügen.
  • Das Verzeichnis 'jdks' mit drei Dateien für .net, java und javascript angelegt.
  • ...
  • Definition of Done wurde geprüft
Edited by Wojciech Gdaniec