[Epic] Neukonzeption der Codebeispiele

Warum?

In der Dokumentation gibt es leere Codebeispiel-Tabs. Diese Beispiele würden aber Entwickler viel helfen.

Um die Pflege der großen Zahl von Codebeispielen zu vereinfachen, suchen wir in eine wartbare Lösung für getestete Codebeispiele.

Bsp.: https://docs.fitko.de/fit-connect/docs/getting-started/authentication

Liste von Beispielen:

• OAuth-Token holen
• SETs erstellen und validieren
• Zustellpunkt ermitteln
• Areas/Gebiete ermitteln
• Destination via API ermitteln
• Einreichung anlegen
• Verschlüsseln
• Anlage hochladen
• Einreichung versenden
• Metadatensatz aufbauen (?) - existiert noch nicht
• Status abfragen
• Polling für Submissions
• Prüfung von Callbacks
• Einreichung herunterladen
• Anlagen herunterladen
• Entschlüsseln
• Validierung von Metadaten (?) - existiert noch nicht

Links/Bemerkungen

• JDoodle - Free AI powered Online Coding Platform (von @Martin_Vogel ) müsste im Detail angeschaut werden

Akzeptanzkriterien

1. [ ] Alle Codebeispiele liegen für Java, C# und Curl vor
   • [ ] Alle Codebeispiele sind in Docusaurus-Tabs dargestellt (<Tabs><TabItem>...)
   • [ ] Stellen für zusätzliche Codebeispiele sind markiert und als Issue angelegt
2. Codebeispiele werden nicht mehr manuell in der Doku gepflegt sondern nur noch an einem Ort und automatisch in der Dokumentation dargestellt.
3. Es ist sichergestellt, dass die Codebesipiele funktionsfähig sind.
4. ~~[ ] Alle Codebeispiele erfüllen die ~~Vorgaben für kryptographische Verfahren

moved from docs#41 (moved)

changed milestone to %Livegang Submission API, OAuth und SSP im Produktivumgebung bei IT.N und FJD RZ

added component::Dokumentation label

marked this issue as related to #15 (closed)

marked this issue as related to #248 (closed)

changed milestone to %1.0.1 BUGS !! und Dokumentation auch

changed title from Code-Beispiel: Token-Abruf [Java] to Ergänzung und Überarbeitung der Code-Beispiele in der Dokumentation

changed the description

mentioned in issue #248 (closed)

changed milestone to %Livegang Submission API, OAuth und SSP im Produktivumgebung bei IT.N und FJD RZ

changed time estimate to 2w

changed time estimate to 3w

changed milestone to %Anbindung erstes Verfahren in der produktiven Umgebung (Stufe I)

changed the description

added 1 deleted label

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

changed the description

mentioned in issue #302 (closed)

marked this issue as related to #96

marked this issue as related to #128

changed the description

assigned to @Pascal_Osterwinter

changed milestone to %Anbindung erstes Verfahren in der produktiven Umgebung (Stufe II)

unassigned @Pascal_Osterwinter

Reevaluate: Zeit besser zunächst in SDKs investieren.

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

changed milestone to %Story und Task Kandidaten für Q2 2022

added Epic::Doku-Einstieg optimieren label

changed milestone to %Story und Task Kandidaten für Q3 2022

mentioned in issue #488 (closed)

marked this issue as related to #550 (closed)

changed milestone to %Story und Task Kandidaten für Q4 2022

changed milestone to %Q-1 (Y-2023)

changed milestone to %Q-2 (Y-2023)

Ich denke wir sollten hier auch Code-Beispiele der SDK-Nutzung unbedingt ergänzen, bzw. darauf sogar den Fokus legen.

@Marco_Holz, @Pascal_Osterwinter: ich finde das Issue ist eigentlich besser im Team Testing als Dokumentation aufgehoben? Meint ihr nicht?

added team::Testing label

removed team::Doku label

changed milestone to %Q-3 (Y-2023)

added team::Doku team::SDK labels

removed team::Testing label

added type::Story label

added workflow::Ready label

changed milestone to %S-2 (PI-6 / Q-1)