digiwf-core icon indicating copy to clipboard operation
digiwf-core copied to clipboard

Service Readme umsetzen

Open simonhir opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

Die in #1383 erstellten Readme-Templates müssen für alle Service erstellt werden, damit diese direkt im Code dokumentiert sind. Dabei ist darauf zu achten, dass Informationen sinnvoll in die Readme ~~oder die öffentliche Dokumentation~~ verteilt und verlinkt sind.

Describe the solution you'd like

Readme für alle Services anlegen. Positioniert sollen diese immer im übergeordneten Ordner und nicht direkt im service-Paket werden. Bei Integrationen ist besonders darauf zu achten, dass technische Informationen aus https://digiwf.oss.muenchen.de/integrations/ in die Readme verschoben ~~und Modellierungs-Informationen in die Modellierungs-Doku mit dem ebenfalls erstellen Templates verschoben~~ werden.

Describe alternatives you've considered

  • Dokumentation wie aktuell weiter führen: Problem: gemischte technische und Modellierungs-Doku

Acceptance Criteria

  • [ ] Für jeden Service im digiwf-core existiert eine README nach dem Template ~~- [ ] Der separate Punkt "Integrationen" in der öffentlichen Dokumentation existiert nicht mehr~~ ~~- [ ] Für alle Integrationen existiert im Modellierungs-Teil der öffentlichen Dokumentation ein Eintrag entsprechend des zugehörigen Templates~~
  • [ ] Die öffentliche Integrations-Dokumentation verweis für technische Informationen nur noch auf die entsprechende README

Additional context

simonhir avatar Feb 29 '24 10:02 simonhir

Hey team! Please add your planning poker estimate with Zenhub @darenegade @lehju @simonhir

markostreich avatar Mar 01 '24 09:03 markostreich

Integrationen

  • [x] address-integration
  • [x] alw-integration
  • [x] cosys-integration
  • [x] dms-integration
  • [ ] email-integration
  • [ ] example-integration
  • [ ] okewo-integration
  • [ ] openai-integration
  • [ ] s3-integration
  • [ ] ticket-integration

markostreich avatar Jul 09 '24 08:07 markostreich

Das Ticket wird wegen Abbruch des Projektes geschlossen.

Die Integrationen werden/wurden im RefArch-Projekt dokumentiert, soweit sie dorthin übernommen werden.

markostreich avatar Sep 05 '24 09:09 markostreich