Skip to content

Commit

Permalink
#13 initial version of chapter 8
Browse files Browse the repository at this point in the history
  • Loading branch information
sippsack committed Nov 21, 2024
1 parent 0d59d72 commit 4a25f1a
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 47 deletions.
4 changes: 2 additions & 2 deletions docs/08-api-governance/00-structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}]
Expand Down
17 changes: 4 additions & 13 deletions docs/08-api-governance/01-duration-terms.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
55 changes: 34 additions & 21 deletions docs/08-api-governance/02-learning-goals.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
11 changes: 0 additions & 11 deletions docs/08-api-governance/references.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
=== {references}

<<starke>>

[NOTE]
====
Eine Quelle wird über `\<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
= = =
A reference source is referenced via `\<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
====

// tag::DE[]
// silence asciidoctor warnings
// end::DE[]
Expand Down

0 comments on commit 4a25f1a

Please sign in to comment.