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

Warum?

Das .NET-SDK ist in der Version 1.0.0. verfügbar. Die Dokumentation muss beschreiben, wie Software-Entwickler damit arbeiten können.

Relevante Links und Bemerkungen

Mockup:

Merge-Request

Dieses Issue wird im folgenden Merge-Request umgesetzt: docs!292 (merged)

Bemerkung

Von Alex:

• Alle Top-Level Einträge im Plural
• Sicherstellen, dass die Navigation ordentlich aussieht und nicht über zwei Zeilen umgebrochen werden.

Akzeptanzkriterien

1. Es existiert ein Navigationspunkt für SDKs und mit einem Dropdown für die Unterseiten. Zusätzlich prüfen, ob der Dropdown auch nochmal als Seitenleiste zusätzlich umgesetzt wird.
2. Eine Übersichtsseite beschreibt, dass über diesen Bereich die SDKs für FIT-Connect bereitgestellt werden und deren Nutzung/Einbindung beschrieben wird. Es werden die Vorteile und Nachteile der SDKs für den Aufruf der Routing- und Submission-API beschrieben (so müssen zum Beispiel sendende Systeme nicht selbst die Metadaten erstellen, empfangende Systeme müssen nicht selbst die Metadaten prüfen).
3. Aussage vorhanden, dass es drei SDKs gibt (für .NET, Java und JavaScript). Es wird in der Übersichtsseits beschrieben, welche SDKs schon da sind und welche noch in der Erstellung sind. Der aktuelle und geplante funktionale Umfang der SDKs wird Schlagwortartig beschrieben. Die besondere Rolle des Javascript SDKs (Verschlüsselung im Browser) und dessen Einbindung in den anderen SDKs wird ersichtlich.
4. Links eingefügt zu den Unterseiten, auf denen das Java- und das JavaScript-SDK beschrieben sind. Hier wird in der Seite beschrieben, dass die SDKs demnächst verfügbar sind.
5. Das .NET-SDK ist als NuGet-Package verfügbar. In der Dokumentation ist beschrieben, wie Software-Entwickler das Package in ihre Projekte einbinden (In Visual Studio 2019).
6. Ein Verweis auf das GitLab-Repo für das .NET-SDK ist vorhanden, als alternative Bezugsquelle. Ggf. auch schreiben, dass das SDKs dort gepflegt wird.
7. Aussage vorhanden, dass das .NET-SDK in der Version 1.0.0. vorliegt und dass diese Version für den produktiven Einsatz freigegeben ist.
8. Das .NET-SDK verwendet als Ziel-Framework .NET 6.0 ( TargetFramework = net6.0).
9. Die Dokumentation verwendet Auszüge aus dem Quellcode des Projekts "DemoRunner", um zu zeigen, wie das SDK für ein sendendes System verwendet wird, wie auch für empfangendes System.
10. Zudem wird gezeigt, wie sendende Systeme, die Methode "FindDestinationsAsync" der Klasse Router verwenden, um die destinationID des Zustellpunktes und den zuständigen Zustelldienst (submissionUrl) ermitteln.
11. Neu: Das NuGet-Paket ist verlinkt.
12. NEU: Dokumentation der SetReplyChannel-Methode
13. NEU: Nutzung von einheitlichen Beispielwerten (z.B. Leika-Schlüssel und Leistungsname) (siehe auch #96)

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.
• zum Akzeptanzkriterium 13: Service-Identifier: "urn:de:fim:leika:leistung:99400048079000", Name: "FIT Connect Demo", leikaKey: "99400048079000"
• ...
• Definition of Done wurde geprüft
• Merge-Request ist approved: 596_Dokumentation_der_Nutzung_des_NET-SDK(#596 (closed)) (Peer-Review)