Skip to content

Commit

Permalink
#326 Fix typos and prepare diagram replacement
Browse files Browse the repository at this point in the history
for extended deployment documentation.
  • Loading branch information
ascheman committed Jan 27, 2025
1 parent f0d7a56 commit 27081a7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 32 deletions.
37 changes: 25 additions & 12 deletions src/docs/arc42/chapters/chap-07-Deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

38 changes: 18 additions & 20 deletions src/docs/plantuml/deployment-context.puml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 27081a7

Please sign in to comment.