Merge pull request #7 from isaqb-org/prepare-for-release

Prepare for Release

build.gradle

@@ -1,103 +1,45 @@
-import org.asciidoctor.gradle.jvm.AsciidoctorTask
 import java.text.SimpleDateFormat
 
 plugins {
-    id "org.asciidoctor.jvm.base" version "3.3.2"
-    id "org.asciidoctor.jvm.convert" version "3.3.2"
-    id "org.asciidoctor.jvm.pdf" version "3.3.2"
-}
-repositories {
-    mavenCentral()
-}
-
-asciidoctorj {
-    version = '2.5.3'
+    id "java"
+    id "application"
 }
 
-ext {
-    today = new Date()
-    versionDate = new SimpleDateFormat("yyyyMMdd").format(today)
+def group = "org.isaqb"
+def releaseVersion = System.getenv("RELEASE_VERSION")
+def localVersion = "LocalBuild"
+project.version = releaseVersion == null ? localVersion : releaseVersion
+def curriculumFileName = "examination-regulations"
+def criteriaFileName = "examination-criteria"
+def versionDate = new SimpleDateFormat("yyyyMMdd").format(new Date())
+def languages = ["DE", "EN"]
 
-    releaseVersion = System.getenv("RELEASE_VERSION")
-    localVersion = "LocalBuild"
-    project.version = releaseVersion == null ? localVersion : releaseVersion;
-
-    curriculumFileName = "examination-regulations"
-    addSuffixToCurriculum = { suffix ->
-        for (extension in ["html", "pdf"]) {
-            File source = new File("${buildDir}/${curriculumFileName}.${extension}")
-            File target = new File("${buildDir}/${curriculumFileName}${suffix}.${extension}")
-
-            source.renameTo(target)
-        }
-    }
+repositories {
+    mavenCentral()
 }
 
-
-
-
-class RenderCurriculumTask extends AsciidoctorTask {
-    @Inject
-    RenderCurriculumTask(WorkerExecutor we, String curriculumFileName, String versionDate, String language) {
-        super(we)
-
-        forkOptions {
-            jvmArgs "--add-opens", "java.base/sun.nio.ch=ALL-UNNAMED", "--add-opens", "java.base/java.io=ALL-UNNAMED"
-        }
-
-
-        sourceDir = new File("./docs/")
-        baseDir = new File ("./docs/")
-        sources {
-            include "index.adoc"
-            include "examination-criteria.adoc"
-            include "${curriculumFileName}.adoc"
-        }
-        outputDir = new File("./build/")
-        outputOptions {
-            separateOutputDirs = false
-            backends 'pdf', 'html5'
-        }
-
-        def fileVersion = project.version.trim() + "-" + language
-
-        attributes = [
-                'icons'             : 'font',
-                'version-label'     : '',
-                'revnumber'         : fileVersion,
-                'revdate'           : versionDate,
-                'document-version'  : fileVersion + "-" + versionDate,
-                'currentDate'       : versionDate,
-                'language'          : language,
-                'curriculumFileName': curriculumFileName,
-                'debug_adoc'        : false,
-                'pdf-stylesdir'     : '../pdf-theme/themes',
-                'pdf-fontsdir'      : '../pdf-theme/fonts',
-                'pdf-style'         : 'isaqb',
-                'stylesheet'        : '../html-theme/adoc-github.css',
-                'stylesheet-dir'    : '../html-theme'
-        ]
-    }
+dependencies {
+    implementation("org.asciidoctor:asciidoctorj:2.5.10")
+    implementation("org.asciidoctor:asciidoctorj-pdf:2.3.9")
 }
 
-task buildDocs {
-    group 'Documentation'
-    description 'Grouping task for generating all languages in several formats'
-    dependsOn "renderDE", "renderEN"
+application {
+    mainClass.set("org.isaqb.asciidoc.Main")
+    applicationDefaultJvmArgs = [
+        """-DprojectVersion=${project.version}""",
+        """-DcurriculumFileName=${curriculumFileName}""",
+        """-DcriteriaFileName=${criteriaFileName}""",
+        """-DversionDate=${versionDate}""",
+        """-Dlanguages=${languages.join(',')}""",
+        """--add-opens""", """java.base/sun.nio.ch=ALL-UNNAMED""",
+        """--add-opens""", """java.base/java.io=ALL-UNNAMED"""]
 }
 
-task renderDE(type: RenderCurriculumTask,
-        constructorArgs: [curriculumFileName, versionDate, "DE"]) {
-    doLast {
-        addSuffixToCurriculum("-de")
-    }
-}
 
-task renderEN(type: RenderCurriculumTask,
-        constructorArgs: [curriculumFileName, versionDate, "EN"]) {
-    doLast {
-        addSuffixToCurriculum("-en")
-    }
+tasks.register('buildDocs') {
+    description = 'Grouping task for generating all languages in several formats'
+    group = 'documentation'
+    dependsOn "run"
 }
 
 defaultTasks "buildDocs"

docs/05-criteria/00-structure.adoc

@@ -1,9 +1,15 @@
+// we have to adjust the heading levels of all included files, as this structure file
+// is used as the only include for the examination-criteria, and thus requires a different
+// heading structure. Some of the files included below are also included in examination-regulations,
+// which is why they should follow the regular heading style of all the other files.
+// therefore, we also do not need a specific German/English section. To remove warnings, we'll just
+// add empty blocks.
+:leveloffset: -2
+
 // tag::DE[]
-== Kriterien
 // end::DE[]
 
 // tag::EN[]
-== Criteria
 // end::EN[]
 
 include::01-accreditation.adoc[{include_configuration}]

docs/05-criteria/01-accreditation.adoc

@@ -1,5 +1,4 @@
 // tag::DE[]
-=== Akkreditierung
 ==== Trainingsprovider
 Trainingsprovider müssen nachfolgende Kriterien erfüllen, damit sie von iSAQB die Akkreditierung bekommen:
 
@@ -45,7 +44,10 @@ Zur Akkreditierung muss ein:e Themenmoderator:in folgende Kriterien erfüllen:
 // end::DE[]
 
 // tag::EN[]
-=== Accreditation
+==== Training Provider
 TODO
 
+==== Training Facilitators
+
+
 // end::EN[]

docs/05-criteria/05-criteria-roadmap.adoc

@@ -44,7 +44,7 @@
 // tag::EN[]
 ==== Criteria for a Roadmap
 
-[cols="<3,<1,<7a"]
+[cols="<3,<2,<7a"]
 |===
 | Criterion | Requirement | Description
 

docs/05-criteria/06-criteria-formal.adoc

@@ -90,7 +90,7 @@
 
 ==== Formal Criteria
 
-[cols="<3,<1,<7a"]
+[cols="<3,<2,<7a"]
 |===
 | Criterion | Requirement | Description
 

docs/config/setup.adoc

@@ -2,7 +2,8 @@
 :icons: font
 :sectnumlevels: 2
 :imagesdir: images
-:chapter-label:
+
+:!chapter-signifier:
 
 // ":language:" denotes the language or the target document.
 // currently only DE and EN are supported

docs/config/setup_criteria.adoc

@@ -6,7 +6,6 @@ ifeval::["{language}" == "DE"]
 endif::[]
 
 ifeval::["{language}" == "EN"]
-:curriculum-name: FULL NAME OF MODULE
 :curriculum-header-title: Criteria for the iSAQB® CPSA® Expert Level
 :hyphens: en_US
 endif::[]

docs/config/setup_regulations.adoc

@@ -1,14 +1,11 @@
 include::setup.adoc[]
 
-:curriculum-short: MODULKUERZEL
-
 ifeval::["{language}" == "DE"]
 :curriculum-header-title: Prüfungsordnung iSAQB® CPSA® Expert Level
 :hyphens: de
 endif::[]
 
 ifeval::["{language}" == "EN"]
-:curriculum-name: FULL NAME OF MODULE
 :curriculum-header-title: Examination Regulations iSAQB® CPSA® Expert Level
 :hyphens: en_US
 endif::[]

docs/examination-criteria.adoc

@@ -4,25 +4,19 @@ include::config/setup_criteria.adoc[]
 
 ifeval::["{language}" == "DE"]
 = Kriterien für pass:q[<br><br>]Certified Professional forpass:q[<br>]Software Architecture (CPSA)^(R)^pass:q[<br>]_Expert Level_ pass:q[<br>]
-:toc-title: Inhaltsverzeichnis
-:toc: left
 endif::[]
 
 ifeval::["{language}" == "EN"]
 = Criteria for pass:q[<br><br>]Certified Professional forpass:q[<br>]Software Architecture (CPSA)^(R)^pass:q[<br>]_Expert Level_ pass:q[<br>]
-:toc: left
 endif::[]
 
 // define terms for toc, learning-goals
 include::config/i18n-definitions.adoc[tags={language}]
 
-<<<
 :sectnums!:
-include::../license-copyright/copyright.adoc[{include_configuration}]
 
 <<<
-toc::[]
+include::../license-copyright/copyright.adoc[{include_configuration}]
 
 <<<
-:sectnums:
 include::05-criteria/00-structure.adoc[{include_configuration}]

docs/index.adoc

@@ -1,31 +1,29 @@
 include::config/setup.adoc[]
 
 = image:isaqb-logo.jpg[width=150]Certified Professional for Software Architecture^(R)^ (CPSA)
-Curriculum {curriculum-name} [{curriculum-short}]
+Expert Level
 
 The international Software Architecture Qualification Board (link:https://isaqb.org[iSAQB]) defines curricula on several levels for software architects.
 
 The terminology used in the iSAQB curricula can be found as a (freely available) ebook, published on https://leanpub.com/isaqbglossary/read[Leanpub].
 
-== Development versions
+The regulations and criteria of the Expert Level are currently maintained and published in both English (EN) and German (DE).
+Maintainers and volunteer reviewers collaborate on GitHub to improve those documents.
 
-The Advanced Level Template Curriculum is currently maintained and published in both English (EN) and German (DE).
-Maintainers and volunteer reviewers collaborate on GitHub to improve the curriculum.
-
-[cols="<,^,^"]
+[cols="<,<"]
 |===
-| Version | HTML | PDF
+| German | English
+
+| link:examination-regulations-de.pdf[Prüfungsordnung (PDF)]
+| link:examination-regulations-en.pdf[Examination Regulations (PDF)]
 
-| German
-| link:{curriculumFileName}-de.html[HTML]
-| link:{curriculumFileName}-de.pdf[PDF]
+| link:examination-criteria-de.pdf[Kriterien (PDF)]
+| link:examination-criteria-en.pdf[Examination Criteria (PDF)]
 
-| English
-| link:{curriculumFileName}-en.html[HTML]
-| link:{curriculumFileName}-en.pdf[PDF]
+| link:iSAQB_CPSA_Expert_Level_Template_Roadmap_DE.docx[Vorlage für eine Roadmap (DOCX)]
+| link:iSAQB_CPSA_Expert_Level_Template_Roadmap_DE.docx[Roadmap Template (DOCX)]
 
-| Español
-|
-| link:{curriculumFileName}-es.pdf[PDF]
+| link:iSAQB_CPSA_Expert_Level_Field_Report_DE.docx[Erfahrungsbericht zum Expert Level (DOCX)]
+| link:iSAQB_CPSA_Expert_Level_Field_Report_EN.docx[Field Report Expert Level (DOCX)]
 
 |===

docs/index_rc.adoc

@@ -1,32 +1,40 @@
 include::config/setup.adoc[]
 
 = image:isaqb-logo.jpg[width=150]Certified Professional for Software Architecture^(R)^ (CPSA)
-- Curriculum {curriculum-name} [{curriculum-short}] – Release Candidate -
+Expert Level
 
 The international Software Architecture Qualification Board (link:https://isaqb.org[iSAQB]) defines curricula on several levels for software architects.
 
-The **Release Candidates** of the **{curriculum-name} [{curriculum-short}]** advanced level curriculum are currently maintained and published in both English (EN) and German (DE). Maintainers of this curriculum and voluntary reviewers collaborate on https://github.com/isaqb-org[GitHub] to improve the curriculum.
 
-== Current Release Candidate v2023.1
+The **Release Candidates** of the **Expert Level Regulations and Criteria** are currently maintained and published in both English (EN) and German (DE).
+Maintainers of this curriculum and voluntary reviewers collaborate on https://github.com/isaqb-org[GitHub] to improve the curriculum.
 
-image:https://img.shields.io/github/last-commit/isaqb-org/advanced-template/main.svg["Last commit"]
-image:https://img.shields.io/github/contributors/isaqb-org/advanced-template.svg["Contributors",link="https://github.com/isaqb-org/advanced-template/graphs/contributors"]
-image:https://img.shields.io/github/issues/isaqb-org/advanced-template.svg["Issues",link="https://github.com/isaqb-org/advanced-template/issues"]
-image:https://img.shields.io/github/issues-closed/isaqb-org/advanced-template.svg["Issues closed",link="https://github.com/isaqb-org/advanced-template/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+"]
-image:https://img.shields.io/github/commits-since/isaqb-org/advanced-template/latest.svg[]
+== Current Release Candidate {document-version}
+
+image:https://img.shields.io/github/last-commit/isaqb-org/examination-expert/main.svg["Last commit"]
+image:https://img.shields.io/github/contributors/isaqb-org/examination-expert.svg["Contributors",link="https://github.com/isaqb-org/examination-expert/graphs/contributors"]
+image:https://img.shields.io/github/issues/isaqb-org/examination-expert.svg["Issues",link="https://github.com/isaqb-org/examination-expert/issues"]
+image:https://img.shields.io/github/issues-closed/isaqb-org/examination-expert.svg["Issues closed",link="https://github.com/isaqb-org/examination-expert/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+"]
+image:https://img.shields.io/github/commits-since/isaqb-org/examination-expert/latest.svg[]
+[cols="<,<"]
 |===
-| Version | HTML | PDF
+| German | English
+
+| link:examination-regulations-de.pdf[Prüfungsordnung (PDF)]
+| link:examination-regulations-en.pdf[Examination Regulations (PDF)]
 
-| German
-| link:{curriculumFileName}-de.html[HTML]
-| link:{curriculumFileName}-de.pdf[PDF]
+| link:examination-criteria-de.pdf[Kriterien (PDF)]
+| link:examination-criteria-en.pdf[Examination Criteria (PDF)]
 
-| English
-| link:{curriculumFileName}-en.html[HTML]
-| link:{curriculumFileName}-en.pdf[PDF]
+| link:iSAQB_CPSA_Expert_Level_Template_Roadmap_DE.docx[Vorlage für eine Roadmap (DOCX)]
+| link:iSAQB_CPSA_Expert_Level_Template_Roadmap_DE.docx[Roadmap Template (DOCX)]
+
+| link:iSAQB_CPSA_Expert_Level_Field_Report_DE.docx[Erfahrungsbericht zum Expert Level (DOCX)]
+| link:iSAQB_CPSA_Expert_Level_Field_Report_EN.docx[Field Report Expert Level (DOCX)]
 
 |===
 
-== Changes compared to XXX
-- link:https://github.com/isaqb-org/advanced-template/blob/main/CHANGELOG.md[CHANGELOG.md on GitHub]
+
+== Changes compared to the previous version
+- link:https://github.com/isaqb-org/examination-expert/blob/main/CHANGELOG.md[CHANGELOG.md on GitHub]
 // - link: [HTML diff to the latest curriculum] T.B.A.

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists