Dokumentation Code-Beispiele .NET-SDK
Warum?
Als Softwareentwickler:in möchte ich zur Anbindung an FIT-Connect die bereitgestellten SDKs nutzen. Hierzu möchte ich in den jeweiligen Code-Beispielen erklärt bekommen, wie die SDKs genutzt werden können.
Relevante Links und Bemerkungen
- Weitere Idee: Screencast
- Docusaurs unterstützt synchronisierte Tabs: https://docusaurus.io/docs/markdown-features/tabs#syncing-tab-choices
Akzeptanzkriterien
-
Einleitung zur Bereitstellung von CURL und Code Beispielen in der "Getting Started" Startseite. -
In allen Code-Beispiel-Tabs existiert der Tab ".NET (SDK)" -
In allen neuen Tabs sind entsprechende Beispielaufrufe zur Nutzung des .NET-SDKs vorhanden. NEU: Falls die von jeweiligen Code-Beispiel abgedeckte Funktionalität bereits SDK-intern umgesetzt ist und von Nutzenden des SDK daher nicht umgesetzt werden muss, reicht statt einem Code-Beispiel auch der folgende Hinweis: "Diese Funktionalität wird durch das SDK bereits intern umgesetzt und ist durch einen Aufruf der SDK-Methode XYZbereits automatisch mit abgedeckt." -
Alle neuen Code-Beispiele sind im Repo https://git.fitko.de/fit-connect/examples/ hinterlegt. -
In der Dokumentation ist bei jedem Code-Beispiel als HTML-Kommentar die Quelle im examples-Repo verlinkt.
Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)
-
... -
... -
... -
Definition of Done wurde geprüft
Merge-Request approved: 797_Dokumentation_Code-Beispiele_NET-SDK(#797 (closed))