From 702025d6044b4241f18c2c31772a008bce43c8a3 Mon Sep 17 00:00:00 2001
From: Gerd Aschemann <gerd@aschemann.net>
Date: Tue, 13 Aug 2024 11:42:02 +0200
Subject: [PATCH] WIP 332 Unify and describe documentation build

---
 generate-pages                                | 55 +++++++++++++------
 src/docs/development/documentation-build.adoc | 25 +++++++++
 2 files changed, 64 insertions(+), 16 deletions(-)
 create mode 100644 src/docs/development/documentation-build.adoc

diff --git a/generate-pages b/generate-pages
index 1fd0f3e6..7e493fdf 100755
--- a/generate-pages
+++ b/generate-pages
@@ -1,24 +1,47 @@
 #!/usr/bin/env bash
 
-: "${DTC_VERSION:=3.3.1}"
-: "${DTC_TASKS:=exportExcel generateHTML generateSite generatePdf}"
+: "${DTC_VERSION:=3.4.0}"
+: "${DTC_TASKS:=exportExcel generateHtml generateSite generatePdf}"
 
-# Generate GH Pages with docToolchain
+# Use a local version!
 test -d "${HOME}/.doctoolchain/docToolchain-${DTC_VERSION}" || ./dtcw local install doctoolchain
-# test -d "${HOME}/.doctoolchain/jdk" || ./dtcw local install java
+test -d "${HOME}/.doctoolchain/jdk" || ./dtcw local install java
 
-set -eu
+set -eu -o pipefail
 
-rm -rf build public
+run() {
+    local title="${1}"
+    shift
+    local action="${@}"
 
-./gradlew publishAllPublicationsToMyLocalRepositoryForFullIntegrationTestsRepository
+    echo "##########################"
+    echo "### ${title} ###"
+    echo "####### Start ############"
 
-./dtcw local "${DTC_TASKS}"
-find build/microsite/output/. -name "*-draft.html" -type f -delete
-cp -rp ./build/pdf ./build/microsite/output
-cp -p ./build/html5/arc42/hsc_arc42.html ./build/microsite/output/arc42/hsc_arc42-standalone.html
-cp -rp ./build/html5/images/* ./build/microsite/output/images/
-# ./dtcw htmlSanityCheck
-(cd self-check && ../gradlew htmlSanityChec)
-cp -rp ./build/reports/htmlchecks ./build/microsite/output
-cp -rp ./build/microsite/output ./public
+    bash -c "${action}"
+
+    echo "######## End #############"
+    echo
+}
+
+run "CleanUp build"     rm -rf build/html5 build/microsite build/pdf
+run "DTC (tasks '${DTC_TASKS}' with version '${DTC_VERSION}')" \
+                        ./dtcw local "${DTC_TASKS}"
+
+run "CleanUp Internals" rm -rf build/microsite/output/excel
+run "CleanUp Drafts"    find build/microsite/output/. -name "*-draft.html" -type f -delete
+run "CleanUp Reports"   rm -rf build/report build/test-results
+run copyPdf             cp -rp build/pdf build/microsite/output
+run copyStandalone      cp -rp build/html5/images build/microsite/output \
+                          && mkdir -p build/microsite/output/single-page/ \
+                          && cp -p build/html5/arc42/hsc_arc42.html build/microsite/output/single-page/hsc_arc42-single-page.html
+run htmlSanityCheck     "(cd self-check && ../gradlew htmlSanityCheck)"
+run copyCheckResult     cp -rp build/reports/htmlchecks build/microsite/output
+run fixDocLinks         'sed -i .bak \
+                          -e "s, href=\"${PWD}/build/microsite/output/, href=\"../,g" \
+                          -e "s,\">${PWD}/build/microsite/output/,\">,g" \
+                          build/microsite/output/htmlchecks/index.html' \
+                        && rm -f build/microsite/output/htmlchecks/index.html.bak
+
+run "CleanUp public"    rm -rf public
+run copyToPublic        cp -rp build/microsite/output public
diff --git a/src/docs/development/documentation-build.adoc b/src/docs/development/documentation-build.adoc
new file mode 100644
index 00000000..163a3fa6
--- /dev/null
+++ b/src/docs/development/documentation-build.adoc
@@ -0,0 +1,25 @@
+:filename: development/documentation-build.adoc
+:jbake-title: Documentation Build
+:jbake-type: page
+:jbake-status: published
+:jbake-menu: development
+:jbake-order: 70
+== {jbake-title}
+
+The documentation is maintained using the awesome
+https://github.com/docToolchain/docToolchain[docToolchain], created by https://rdmueller.github.io/[@rdmueller].
+
+Build the complete documentation by executing the following build script:
+
+[source,bash]
+----
+./generate-pages
+----
+
+Afterwards, open
+
+// TODO enable linking to right file when running outside of JBake
+// :doc-base: ../../../public
+ifdef::jbake-type[:doc-base: ..]
+* xref:{doc-base}/index.adoc[`public/index.html`] to check the results, or
+* The xref:{doc-base}/report/report.adoc[HSC report] to check the quality.