From 4a25f1acec793158b9ae92295202afff8ab5879b Mon Sep 17 00:00:00 2001 From: Falk Sippach Date: Thu, 21 Nov 2024 01:02:45 +0100 Subject: [PATCH] #13 initial version of chapter 8 --- docs/08-api-governance/00-structure.adoc | 4 +- docs/08-api-governance/01-duration-terms.adoc | 17 ++---- docs/08-api-governance/02-learning-goals.adoc | 55 ++++++++++++------- docs/08-api-governance/references.adoc | 11 ---- 4 files changed, 40 insertions(+), 47 deletions(-) diff --git a/docs/08-api-governance/00-structure.adoc b/docs/08-api-governance/00-structure.adoc index 9a32fdf..39479bd 100644 --- a/docs/08-api-governance/00-structure.adoc +++ b/docs/08-api-governance/00-structure.adoc @@ -3,11 +3,11 @@ // ==================================================== // tag::DE[] -== Und so heißt Modul 5 +== APIs at Scale: Plattformen und Governance // end::DE[] // tag::EN[] -== And This is Module no 5 +== APIs at Scale: Platforms and governance // end::EN[] include::01-duration-terms.adoc[{include_configuration}] diff --git a/docs/08-api-governance/01-duration-terms.adoc b/docs/08-api-governance/01-duration-terms.adoc index d1bb5f8..05967ce 100644 --- a/docs/08-api-governance/01-duration-terms.adoc +++ b/docs/08-api-governance/01-duration-terms.adoc @@ -1,29 +1,20 @@ // tag::DE[] |=== -| Dauer: XXX Min. | Übungszeit: XXX Min. +| Dauer: 60 Min. | Übungszeit: 30 Min. |=== === Begriffe und Konzepte -Begriff 1, Begriff 2, Begriff 3 + +Internal Developer Platform (IDP), API Plattform, Business Plattform, API Guidelines, API Design, Plattform, Self Service // end::DE[] // tag::EN[] |=== -| Duration: XXX min | Practice time: XXX min +| Duration: 60 min | Practice time: 30 min |=== === Terms and Principles Term 1, Term 2, Term 3 // end::EN[] - -[NOTE] -==== -Überschrift in 00-structure.adoc ersetzen -==== - -[NOTE] -==== -Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen. -==== diff --git a/docs/08-api-governance/02-learning-goals.adoc b/docs/08-api-governance/02-learning-goals.adoc index 026e525..f111c62 100644 --- a/docs/08-api-governance/02-learning-goals.adoc +++ b/docs/08-api-governance/02-learning-goals.adoc @@ -1,34 +1,47 @@ === {learning-goals} - // tag::DE[] -[[LZ-5-1]] -==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor +[[LZ-8-1]] +==== LZ 8-1: Verschiedene Plattform-Begriffe vergleichen -Hier wird beschrieben, was Teilnehmer:innen in diesem Lernziel lernen sollen. Das kann in Prosa-Text -in ganzen Sätzen oder in Aufzählungen mit Unterpunkten erfolgen. Dabei kann auch unterschieden werden, -wie wichtig einzelne Aspekte des Lernziels sind. Es kann hier bereits auf Literatur verwiesen werden. +Teilnehmer:innen kennen die Bereiche, in denen Plattformen verwendet werden. +Sie verstehen die verschiedenen Begriffe und kennen die Unterschiede sowie das Ineinandergreifen. -* Erstes Teilziel -* Zweites Unterthema -* Dritter Aspekt +* Internal Developer Platform (IDP) +* API Plattform +* Business Plattform + +Teilnehmer:innen können zwischen dem mehr nach innen gerichteten Fokus einer IDP und dem sowohl nach innen als auch nach aussen gerichteten Fokus einer API Plattform unterscheiden. + +[[LZ-8-2]] +==== LZ 8-2: API Guidelines aufstellen + +Teilnehmer:innen verstehen die Motivation von API Guidelines. +Sie kennen die Ziele, um innerhalb eines gewissen Bereiches eine Harmonisierung von API Design und von -Entwicklungspraktiken zu erreichen. +Tools zur Unterstützung von API Guidelines wie Linting sind bekannt und die Funktionsweise ist geläufig. + +[[LZ-8-3]] +==== LZ 8-3: API Guidelines by Example umsetzen + +Die Teilnehmer:innen kennen Beispiele für API Guidelines einiger Organisationen. +Des Weiteren wissen sie, auf welche Art und Weise API Guidelines entwickelt und gepflegt werden. +Sie verstehen es als partizipativ sowie kontinuierlich gepflegtes Dokument von gelebten und unterstützten Praktiken in einer Organisation. + +[[LZ-8-4]] +==== LZ 8-4: APIs als Team-Schnittstellen sehen + +Teilnehmer:innen kennen Team Topologies als organisatorisches Modell für effektiv arbeitende Teams. +Dabei ist der Fokus vor allem darauf gerichtet, an welchen Stellen von Team Topologies der Einsatz von APIs essenziell notwendig ist für die Umsetzung des Modells. +Dies sind der Konsum von Diensten (X-a-a-S Modell) sowie das Anbieten von Diensten durch Platform Teams, die ihre Plattform im Self Service bereitstellen wollen. -[[LZ-5-2]] -==== LZ 5-2: Hier ist ein zweites Lernziel in diesem Kapitel -tbd. // end::DE[] // tag::EN[] -[[LG-5-1]] -==== LG 5-1: TBD +[[LG-8-1]] +==== LG 8-1: TBD tbd. -[[LG-5-2]] -==== LG 5-2: TBD +[[LG-8-2]] +==== LG 8-2: TBD tbd. // end::EN[] - -[NOTE] -==== -Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. -==== diff --git a/docs/08-api-governance/references.adoc b/docs/08-api-governance/references.adoc index 459da49..6c93627 100644 --- a/docs/08-api-governance/references.adoc +++ b/docs/08-api-governance/references.adoc @@ -1,16 +1,5 @@ === {references} -<> - -[NOTE] -==== -Eine Quelle wird über `\<