From 27081a751e7c86a0c6ae610a9eabdef66c8fa4e7 Mon Sep 17 00:00:00 2001
From: Gerd Aschemann <gerd@aschemann.net>
Date: Mon, 27 Jan 2025 08:15:22 +0100
Subject: [PATCH] #326 Fix typos and prepare diagram replacement

for extended deployment documentation.
---
 .../arc42/chapters/chap-07-Deployment.adoc    | 37 ++++++++++++------
 src/docs/plantuml/deployment-context.puml     | 38 +++++++++----------
 2 files changed, 43 insertions(+), 32 deletions(-)

diff --git a/src/docs/arc42/chapters/chap-07-Deployment.adoc b/src/docs/arc42/chapters/chap-07-Deployment.adoc
index 7a50a797..76273545 100644
--- a/src/docs/arc42/chapters/chap-07-Deployment.adoc
+++ b/src/docs/arc42/chapters/chap-07-Deployment.adoc
@@ -9,26 +9,39 @@ include::_config.adoc[]
 :filename: arc42/chapters/chap-07-Deployment.adoc
 
 [[img-deployment]]
-image::ea/htmlSanityCheck/hsc-deployment.png["Deployment", title="Deployment"]
+.Deploymentfootnote:[This diagram is outdated and needs replacement, e.g., with a PlantUML diagram.]
+image::ea/htmlSanityCheck/hsc-deployment.png["Deployment"]
 
 [options="header", cols="1,4"]
 .Deployment
 |===
 | Node / Artifact | Description
-| hsc plugin binary | compiled version of HSC, including required dependencies.
-| hsc-development | where development of HSC takes place
-| artifact repository (https://repo1.maven.org/maven2/[Maven Central]) | public Java artifact repository, cf. https://search.maven.org/[Maven Central Search].
-| hsc user computer | where arbitrary documentation takes place with html as output formats.
-| build.gradle    |  Gradle build script configuring (among other things) the HSC plugin to check _some documentation_.
+
+| HSC plugin binary
+| The compiled version of HSC, including required dependencies.
+
+| hsc-development
+| Where development of HSC takes place
+
+| Artifact Repository (https://repo1.maven.org/maven2/[Maven Central])
+| Public Java artifact repository, cf. https://search.maven.org/[Maven Central Search].
+
+| HSC user computer
+| Where arbitrary documentation takes place with HTML as output formats.
+
+| `build.gradle`
+| Gradle build script configuring (among other things) the HSC plugin to check _some documentation_.
+
 |===
 
 The three nodes (_computers_) shown in <<img-deployment>> are connected via Internet.
 
-Sanity checker will:
+Sanity checker will be:
 
-. be bundled as a single jar,
-. be uploaded to the Bintray repository, 
-. referencable within a gradle buildfile,
-. provide a +main+ method with parameters and options, so all checks can be
-called from the command line.
+. Bundled
+.. As a core jar file (including all checkers and reporters),
+.. As a respective Plugin jar file for Maven and Gradle,
+.. As a CLI jar file, providing a +main+ method with parameters and options to run all checks from the command line,
+. Uploaded to the Maven Central repository (Gradle Plugin also to Gradle Plugin Portal),
+. Referencable within a Gradle build-file.
 
diff --git a/src/docs/plantuml/deployment-context.puml b/src/docs/plantuml/deployment-context.puml
index e3b06d01..a766d72e 100644
--- a/src/docs/plantuml/deployment-context.puml
+++ b/src/docs/plantuml/deployment-context.puml
@@ -1,38 +1,36 @@
 @startuml
-frame "cmp deployment-context" {
+skinparam linetype ortho
 
+frame "cmp deployment-context" {
 
-node hscUser as "hsc's users computer" {
+  node hscUser as "hsc's users computer" {
     artifact htmlfiles as "html files"
     artifact gradle as "build.gradle"
     artifact maven as "build.maven"
     artifact commandline as "commandline"
+  }
 
-
-}
-
-
-node repro as "global artifact repository (e.g. maven central, bintrtay)" {
+  node repo as "global artifact repository (e.g., Maven Central)" {
     artifact hscCore as "hsc-core" <<binary>>
-    artifact hscMavenPlugin as"hsc-maven-plugin" <<binary>>
-    artifact hscGradlePlugin as "hsc-gradle-plugin" <<binary>>
-    artifact hscCli as " hsc-cli" <<binary>>
 
-}
+    artifact hscMavenPlugin as "hsc-maven-plugin" <<binary>>
+    artifact hscGradlePlugin as "hsc-gradle-plugin" <<binary>>
+    artifact hscCli as "hsc-cli" <<binary>>
 
+    hscMavenPlugin -up-> hscCore
+    hscGradlePlugin -up-> hscCore
+    hscCli -up-> hscCore
+  }
 
-node hscd as "hsc deployment" {
+  node hscd as "hsc deployment" {
     artifact hscSrc as " hsc" <<source>>
-}
+  }
 
-hscd --> repro : internet/https
-gradle -up[dashed]-> hscCore
-gradle -up[dashed]-> hscGradlePlugin
-maven -up[dashed]-> hscCore
-maven -up[dashed]-> hscMavenPlugin
-commandline -up[dashed]-> hscCore
-commandline -up[dashed]-> hscCli
+  hscd --> repo : internet/https
 
+  gradle -up[dashed]-> hscGradlePlugin
+  maven -up[dashed]-> hscMavenPlugin
+  commandline -up[dashed]-> hscCli
 }
 @enduml