Dokumentation von Release- und Deploymentzeiten, sowie Update Feature-Roadmap

Warum?

In der Dokumentation sollen unsere Realease- und Deploymentzeiten auf den verschiedenen Umgebungen transparent gemacht werden.

Relevante Links und Bemerkungen

• Slides, siehe https://nextcloud.fitko.net/index.php/f/95442 https://teamraum.hessen.de/gruppen/FITKO/FITCONNECT/Freigegebene%20Dokumente/3_Projektumsetzung/Release_und_Deployprozessee

Grafik 1

Grafik 2

siehe PPT-Datei #522 (comment 55923)

Grafik 3

siehe PPT-Datei https://teamraum.hessen.de/gruppen/FITKO/FITCONNECT/Freigegebene%20Dokumente/3_Projektumsetzung/Anbindungs-Management/Roadmap/Roadmap%202023%20Q1%20.pptx

Akzeptanzkriterien

1. Es wird beschrieben, wie der Releaseplan für die verschiedenen Umgebungen abläuft.
2. Es erläutert, aus welchen Bestandteilen (Zustelldienst, SSP, etc.) ein Release besteht und welche Auswirkungen es auf Systeme / Nutzer von FIT-Connect hat.
3. Es existiert ein Releaseplan, der künftige Änderungen darstellt und ggf. auf detaillierte Release Notes verweist. Dieser Punkt sollte am besten mit einem dynamischen Kalender durchzuführen. Der Kalender wird dann innerhalb der Doku Seite eingearbeitet Hierzu soll eine Darstellung, ähnlich zu Grafik 2 in die Dokumentation eingebunden werden. Die Daten sollen im Quelltext der Seite editierbar sein, d.h. es erfolgt keine einbindung als Grafik.
4. Es wurde geklärt und dokumentiert, wie und durch wen der Releaseplan gepflegt wird.
5. Es wurden Optimierungen am Change Log geprüft, um den Releaseplan und Nachvollziehbarkeit von Releases zu optimieren. Es wurde auch geprüft, ob der Changelog für Umgebungen differenziert wird, da aktuell aus dem Changelog nicht ersichtlich ist, wo welches Release läuft. Ergebnis ist dokumentiert und in Form eines Folge-Issues festgehalten.

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

• Konzept zur Strukturierung und Entwicklung der Seiten und Inhalte entwickeln und mit PO absprechen. Ggf. auch Beispiele von anderen Plattformen sammeln und als Ideen vorstellen.
• ...
• ...
• Definition of Done wurde geprüft

added Epic::Doku-Einstieg optimieren type::Story labels

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

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

changed the description

added 1 deleted label

removed 1 deleted label

added workflow::Ready for Refinement label

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

changed the description

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

changed the description

changed the description

cc @Wojciech_Gdaniec

assigned to @Wojciech_Gdaniec

changed due date to January 24, 2023

@Michael_Haidner anbei der für 2023 aktualisierte Kalender2023-01-25_Master_Releasekalender.pptx

ich würde in der Doku auch noch den Verweis auf das Versionsdashboard ergänzen. https://dashboard.fit-connect.fitko.dev/

assigned to @Michael_Haidner and unassigned @Wojciech_Gdaniec

added workflow::Ready for Refinement label

removed 1 deleted label

@Michael_Haidner bräuchstest du noch weitere Infos für die Ergänzung der Doku? ansonsten könnte das dann aus meiner Sicht auf Ready.

@Wojciech_Gdaniec Die Releasezeiten im Beispiel-Screenshot oben sind veraltet. Könntst Du nochmal die aktuellen Zeiten für 2023 zusammenstellen?

Zu Akzeptanzkriterium 3 sollten wir noch einmal die Machbarkeit prüfen. @Michael_Haidner Hast Du da eine Idee, wie wir das (mit überschaubarem Zeitaufwand) Umsetzen können?

Hey @Marco_Holz @Michael_Haidner ich hatte den neuen Kalender schon vor drei Wochen eingefügt. siehe unten: #522 (comment 55923)

Ah, danke! Hatte ich übersehen.

@Laura_Elges: kannst du hier in das Issue auch die aktualisierte Feature-Roadmap hochladen. Das kann man in dem Zuge bestimmt gemeinsam aktualisieren.

@Marco_Holz: Hallo Marco, ich habe jetzt den react-big-calendar eingefügt, um das Akzeptanzkriterium 3 zu erfüllen. Die Daten zu den einzelnen Terminen sind in der neuen React-Komponente "RoadmapCalendar" als Quellcode einzufügen.

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

changed the description

changed title from Dokumentation von Release- und Deploymentzeiten to Dokumentation von Release- und Deploymentzeiten, sowie Update Feature-Roadmap

changed the description

added workflow::In Progress label and removed workflow::Ready label

mentioned in merge request docs!354 (merged)

mentioned in commit docs@c5e5fb9d

@Michael_Haidner änderst du bitte die Überschrift der Roadmap anstatt "bis 2023" auf "bis 2024"?

mentioned in merge request docs!355 (closed)

unassigned @Michael_Haidner

assigned to @Michael_Haidner

marked the checklist item Es wird beschrieben, wie der Releaseplan für die verschiedenen Umgebungen abläuft. as completed

changed the description

Hey @Michael_Haidner,

danke für die Zusendung des Links zur Prüfung (https://preview.docs.fitko.dev/fit-connect/522-dokumentation-von-release--und-deploymentzeiten/docs/roadmap). Ich hätte die folgenden Anmerkungen:

• Textanpassungen:
  • Flexible Umsetzung der Roadmap
    • hier müsste nicht mehr vom Projekt, sondern von der Roadmap des Produktes gesprochen werden, jedoch die Kernmessageder flexiblen Fertigstellung beibehalten werden.
  • Nutzungsplanung
    • wir sind nun in der freien Nutzung Phase 3, dahingehend müsste der Text angepasst werden - daher würde ich das Bild hier auch rausnehmen. Hier könntest du ergänzen, dass FIT-Connect ein Produkt des IT PLRs ist und frei genutzt werden kann. Gerne kannst du ergänzen, dass man sich bei Anbindungsinteresse melden kann ( -> https://preview.docs.fitko.dev/fit-connect/522-dokumentation-von-release--und-deploymentzeiten/termine/ -> Interessierte)
  • Neue Features für FIT-Connect
    • würde ich rausnehmen (Text passt eh nicht zur Roadmap)
  • Projektbereiche
    • hier würde ich die SDKs auch mit aufnehmen
  • Übersicht zu den aktuellen Versionen der Dienste und APIs für FIT-Connect
    • der Text ist ein wenig Irreführend. würde ich ändern in: "Das FIT-Connect Dashboard erlaubt eine Übersicht der aktuell je Umgebung bereitgestellten Version zu jeder Komponente Komponenten (Dienste, APIs). Inhalte jeder Version können dem Changelog entnommen werden"
    • Dashboard wie aktuell verlinkt lassen
    • Changelog mit https://preview.docs.fitko.dev/fit-connect/522-dokumentation-von-release--und-deploymentzeiten/docs/changelog/ verlinken
• Umsortierung:
  1. "Flexible Umsetzung der Roadmap"
  • "Flexible Umsetzung der Roadmap" - als Überschrift kann raus, da die Seite die Überschrift "Roadmap" schon hat
  • "Feature-Roadmap bis 2024 als Bild zu dem Text (auch ohne Überschrift
  2. "Issue-Tracker" umbenannt in "Ihre Wünsche und Anregungen zur Roadmap
  3. "Projektbereiche" umbenannt in "Produktbereiche"
  4. "Umgebungen für FIT-Connect" umbenannt in "FIT-Connect Umgebungen"
  5. "Übersicht zu den aktuellen Versionen der Dienste und APIs für FIT-Connect" umbenannt in "Aktuelle Versionen der Dienste und APIs je Umgebung"
  6. "Deployments auf die Umgebungen" umbenannt in "Deploymenttermine (der Umgebungen)"

Den Kalender selbst finde ich persönlich nicht ganz so schön. Besser wäre vielleicht eine Tabelle (wie die Grafik mit allen Einträgen).

Bezüglich der regelmäßigen Pflege (Akzeptanzkriterien 3, 4 & 5) @Maik_Boettner kannst du bitte mit Michael einmal sprechen, da du die Prozesse hier gerade aufräumst. Ich denke sinnvoller und aktueller wäre es wenn die Aktualisierung dieser Informationen direkt bei Dir läge, nachdem Michael es initial erstellt hat. Vielleicht hast du auch noch eine Idee bezüglich der Kalenderdarstellung und vielleicht könnte man auch deine Ankündigungsmails dann irgendwo in der Doku immer aktuell veröffentlichen.

Hey Michael, anbei der besprochene Vorschlag zum Kalender als Idee:

Mit Maik besprochen, dass die Versionen mit einem Link auf das Changelog versehen werden können.

mentioned in issue #933 (closed)

Anmerkung bez. Schreibweise/Bezeichnung der Umgebungen, bitte nur noch die Folgenden verwenden:

• Stage-Umgebung (STAGE)
• Produktiv-Umgebung (PROD)
• Test-Umgebung (TEST)
• Dev-Umgebung (DEV)

Danke @Michael_Haidner für das Update, gefällt mir schon mal viel besser. Folgende Punkte würde ich noch optimieren:

• "Von STAGING auf PROD: Jeden Dienstag im Folgemonat." -> "Von STAGING auf PROD: erster Dienstag im Folgemonat."
• Deploymenttermine
  • "Die Namen und Versionsnummern der Dienste und APIs sind jeweils eingetragen:" -> "Die Namen und Versionsnummern der Dienste und APIs sind jeweils eingetragen und auf die jeweilige Beschreibung im Changelog verlinkt:"
  • auch der Termin für Prod müsste aus meiner Sicht hier eingetragen werden (der ist ja immer nachgelagert)
  • @Maik_Boettner: du müsstest dem Michael noch die eingespielten Versionen (am besten ab 1.1.2023) zusschicken. Auch die künftigen Termine bis Jahresende solltet ihr abstimmen und eintragen.
• "FIT-Connect ein Produkt des IT-Planungsrats" -> "FIT-Connect ist ein Produkt des IT-Planungsrats"

marked this issue as related to #605 (closed)

removed the relation with #605 (closed)

Roadmap___FIT-Connect_Anpassungsvorschlag_v1.pdf

marked the checklist item Es existiert ein Releaseplan, der künftige Änderungen darstellt und ggf. auf detaillierte Release Notes verweist. Dieser Punkt sollte am besten mit einem dynamischen Kalender durchzuführen. Der Kalender wird dann innerhalb der Doku Seite eingearbeitet Hierzu soll eine Darstellung, ähnlich zu Grafik 2 in die Dokumentation eingebunden werden. Die Daten sollen im Quelltext der Seite editierbar sein, d.h. es erfolgt keine einbindung als Grafik. as completed

changed the description

added workflow::Blocked label and removed workflow::In Progress label

added workflow::In Progress label and removed workflow::Blocked label

Deployment-Termine__Entwurf_v3_.xlsx

added 1 deleted label

removed 1 deleted label

mentioned in merge request docs!371 (merged)

mentioned in commit docs@6a7382f6

closed

marked the checklist item Es wurde geklärt und dokumentiert, wie und durch wen der Releaseplan gepflegt wird. as completed

marked the checklist item Es wurden Optimierungen am Change Log geprüft, um den Releaseplan und Nachvollziehbarkeit von Releases zu optimieren. Es wurde auch geprüft, ob der Changelog für Umgebungen differenziert wird, da aktuell aus dem Changelog nicht ersichtlich ist, wo welches Release läuft. Ergebnis ist dokumentiert und in Form eines Folge-Issues festgehalten. as completed

mentioned in issue #1025 (closed)