Merge pull request #5 from isaqb-org/proposed-folder-names

suggesting names for folders 3-8
isaqb-org · Nov 20, 2024 · 29a33de · 29a33de
2 parents bab6102 + 32c0499
commit 29a33de
Show file tree

Hide file tree

Showing 25 changed files with 312 additions and 3 deletions.
diff --git a/docs/03-module-block-3/00-structure.adoc → docs/03-api-styles/00-structure.adoc b/docs/03-module-block-3/00-structure.adoc → docs/03-api-styles/00-structure.adoc
diff --git a/.../03-module-block-3/01-duration-terms.adoc → docs/03-api-styles/01-duration-terms.adoc b/.../03-module-block-3/01-duration-terms.adoc → docs/03-api-styles/01-duration-terms.adoc
diff --git a/.../03-module-block-3/02-learning-goals.adoc → docs/03-api-styles/02-learning-goals.adoc b/.../03-module-block-3/02-learning-goals.adoc → docs/03-api-styles/02-learning-goals.adoc
diff --git a/docs/03-module-block-3/references.adoc → docs/03-api-styles/references.adoc b/docs/03-module-block-3/references.adoc → docs/03-api-styles/references.adoc
diff --git a/docs/04-module-block-4/00-structure.adoc → docs/04-api-design/00-structure.adoc b/docs/04-module-block-4/00-structure.adoc → docs/04-api-design/00-structure.adoc
diff --git a/.../04-module-block-4/01-duration-terms.adoc → docs/04-api-design/01-duration-terms.adoc b/.../04-module-block-4/01-duration-terms.adoc → docs/04-api-design/01-duration-terms.adoc
diff --git a/.../04-module-block-4/02-learning-goals.adoc → docs/04-api-design/02-learning-goals.adoc b/.../04-module-block-4/02-learning-goals.adoc → docs/04-api-design/02-learning-goals.adoc
diff --git a/docs/04-module-block-4/references.adoc → docs/04-api-design/references.adoc b/docs/04-module-block-4/references.adoc → docs/04-api-design/references.adoc
diff --git a/docs/05-module-block-5/00-structure.adoc → docs/05-openapi/00-structure.adoc b/docs/05-module-block-5/00-structure.adoc → docs/05-openapi/00-structure.adoc
diff --git a/.../05-module-block-5/01-duration-terms.adoc → docs/05-openapi/01-duration-terms.adoc b/.../05-module-block-5/01-duration-terms.adoc → docs/05-openapi/01-duration-terms.adoc
diff --git a/.../05-module-block-5/02-learning-goals.adoc → docs/05-openapi/02-learning-goals.adoc b/.../05-module-block-5/02-learning-goals.adoc → docs/05-openapi/02-learning-goals.adoc
diff --git a/docs/05-module-block-5/references.adoc → docs/05-openapi/references.adoc b/docs/05-module-block-5/references.adoc → docs/05-openapi/references.adoc
diff --git a/docs/06-api-lifecycle/00-structure.adoc b/docs/06-api-lifecycle/00-structure.adoc
@@ -0,0 +1,18 @@
+// header file for curriculum section 5: Lerneinheit 5
+// (c) iSAQB e.V. (https://isaqb.org)
+// ====================================================
+
+// tag::DE[]
+== Und so heißt Modul 5
+// end::DE[]
+
+// tag::EN[]
+== And This is Module no 5
+// end::EN[]
+
+include::01-duration-terms.adoc[{include_configuration}]
+
+include::02-learning-goals.adoc[{include_configuration}]
+
+// references (if any!)
+include::references.adoc[{include_configuration}]
diff --git a/docs/06-api-lifecycle/01-duration-terms.adoc b/docs/06-api-lifecycle/01-duration-terms.adoc
@@ -0,0 +1,29 @@
+// tag::DE[]
+|===
+| Dauer: XXX Min. | Übungszeit: XXX Min.
+|===
+
+=== Begriffe und Konzepte
+Begriff 1, Begriff 2, Begriff 3
+
+// end::DE[]
+
+// tag::EN[]
+|===
+| Duration: XXX min | Practice time: XXX 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/06-api-lifecycle/02-learning-goals.adoc b/docs/06-api-lifecycle/02-learning-goals.adoc
@@ -0,0 +1,34 @@
+=== {learning-goals}
+
+
+// tag::DE[]
+[[LZ-5-1]]
+==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor
+
+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.
+
+* Erstes Teilziel
+* Zweites Unterthema
+* Dritter Aspekt
+
+[[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
+tbd.
+
+[[LG-5-2]]
+==== LG 5-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/06-api-lifecycle/references.adoc b/docs/06-api-lifecycle/references.adoc
@@ -0,0 +1,19 @@
+=== {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[]
+// tag::EN[]
+// silence asciidoctor warnings
+// end::EN[]
diff --git a/docs/07-api-security/00-structure.adoc b/docs/07-api-security/00-structure.adoc
@@ -0,0 +1,18 @@
+// header file for curriculum section 5: Lerneinheit 5
+// (c) iSAQB e.V. (https://isaqb.org)
+// ====================================================
+
+// tag::DE[]
+== Und so heißt Modul 5
+// end::DE[]
+
+// tag::EN[]
+== And This is Module no 5
+// end::EN[]
+
+include::01-duration-terms.adoc[{include_configuration}]
+
+include::02-learning-goals.adoc[{include_configuration}]
+
+// references (if any!)
+include::references.adoc[{include_configuration}]
diff --git a/docs/07-api-security/01-duration-terms.adoc b/docs/07-api-security/01-duration-terms.adoc
@@ -0,0 +1,29 @@
+// tag::DE[]
+|===
+| Dauer: XXX Min. | Übungszeit: XXX Min.
+|===
+
+=== Begriffe und Konzepte
+Begriff 1, Begriff 2, Begriff 3
+
+// end::DE[]
+
+// tag::EN[]
+|===
+| Duration: XXX min | Practice time: XXX 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/07-api-security/02-learning-goals.adoc b/docs/07-api-security/02-learning-goals.adoc
@@ -0,0 +1,34 @@
+=== {learning-goals}
+
+
+// tag::DE[]
+[[LZ-5-1]]
+==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor
+
+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.
+
+* Erstes Teilziel
+* Zweites Unterthema
+* Dritter Aspekt
+
+[[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
+tbd.
+
+[[LG-5-2]]
+==== LG 5-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/07-api-security/references.adoc b/docs/07-api-security/references.adoc
@@ -0,0 +1,19 @@
+=== {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[]
+// tag::EN[]
+// silence asciidoctor warnings
+// end::EN[]
diff --git a/docs/08-api-governance/00-structure.adoc b/docs/08-api-governance/00-structure.adoc
@@ -0,0 +1,18 @@
+// header file for curriculum section 5: Lerneinheit 5
+// (c) iSAQB e.V. (https://isaqb.org)
+// ====================================================
+
+// tag::DE[]
+== Und so heißt Modul 5
+// end::DE[]
+
+// tag::EN[]
+== And This is Module no 5
+// end::EN[]
+
+include::01-duration-terms.adoc[{include_configuration}]
+
+include::02-learning-goals.adoc[{include_configuration}]
+
+// references (if any!)
+include::references.adoc[{include_configuration}]
diff --git a/docs/08-api-governance/01-duration-terms.adoc b/docs/08-api-governance/01-duration-terms.adoc
@@ -0,0 +1,29 @@
+// tag::DE[]
+|===
+| Dauer: XXX Min. | Übungszeit: XXX Min.
+|===
+
+=== Begriffe und Konzepte
+Begriff 1, Begriff 2, Begriff 3
+
+// end::DE[]
+
+// tag::EN[]
+|===
+| Duration: XXX min | Practice time: XXX 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
@@ -0,0 +1,34 @@
+=== {learning-goals}
+
+
+// tag::DE[]
+[[LZ-5-1]]
+==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor
+
+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.
+
+* Erstes Teilziel
+* Zweites Unterthema
+* Dritter Aspekt
+
+[[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
+tbd.
+
+[[LG-5-2]]
+==== LG 5-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
@@ -0,0 +1,19 @@
+=== {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[]
+// tag::EN[]
+// silence asciidoctor warnings
+// end::EN[]
diff --git a/docs/curriculum-api.adoc b/docs/curriculum-api.adoc
@@ -43,13 +43,22 @@ include::01-why-apis/00-structure.adoc[{include_configuration}]
 include::02-module-block-2/00-structure.adoc[{include_configuration}]
 
 <<<
-include::03-module-block-3/00-structure.adoc[{include_configuration}]
+include::03-api-styles/00-structure.adoc[{include_configuration}]
 
 <<<
-include::04-module-block-4/00-structure.adoc[{include_configuration}]
+include::04-api-design/00-structure.adoc[{include_configuration}]
 
 <<<
-include::05-module-block-5/00-structure.adoc[{include_configuration}]
+include::05-openapi/00-structure.adoc[{include_configuration}]
+
+<<<
+include::06-api-lifecycle/00-structure.adoc[{include_configuration}]
+
+<<<
+include::07-api-security/00-structure.adoc[{include_configuration}]
+
+<<<
+include::08-api-governance/00-structure.adoc[{include_configuration}]
 
 <<<
 include::20-examples/00-examples.adoc[{include_configuration}]