WIP documentation

aim42 · Apr 23, 2024 · cea977e · cea977e
1 parent d01c14b
commit cea977e
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/docToolchainConfig.groovy b/docToolchainConfig.groovy
@@ -17,7 +17,7 @@ inputFiles = [
 //these will be copied as resources to ./images
 //folders are relative to inputPath
 imageDirs = [
-    /** imageDirs **/
+    "images"
 ]
 
 // these are directories (dirs) and files which Gradle monitors for a change

diff --git a/src/docs/Requirements.xlsx b/src/docs/Requirements.xlsx
diff --git a/src/docs/arc42/chapters/chap-03-Context.adoc b/src/docs/arc42/chapters/chap-03-Context.adoc
@@ -39,7 +39,8 @@ image::deployment-context.png["Deployment Context", title="Deployment Context"]
 | Node / Artifact | Description
 | {node} hsc-development | where development of kbd:[HtmlSC] takes place
 | {artifact} hsc-plugin-binary | compiled and packaged version of kbd:[HtmlSC] including required dependencies. 
-| {node} artifact repository (https://bintray.com/bintray/jcenter[Bintray]) | global public _cloud_ repository for binary artifacts, similar to https://search.maven.org/[mavenCentral].  kbd:[HtmlSC] binaries are uploaded to this server.
+| {node} artifact repository (https://repo1.maven.org/maven2/[Maven Central]) | public Java artifact repository, cf. https://search.maven.org/[Maven Central Search].
+kbd:[HtmlSC] binaries are uploaded to this server.
 | {node} hsc user computer | where arbitrary documentation takes place with html as output formats.
 | {artifact} build.gradle | Gradle build script configuring (among other things) the kbd:[HtmlSC] plugin to perform the Html checking.
 |===

diff --git a/src/docs/arc42/chapters/chap-07-Deployment.adoc b/src/docs/arc42/chapters/chap-07-Deployment.adoc
@@ -16,7 +16,7 @@ image::ea/htmlSanityCheck/hsc-deployment.png["Deployment", title="Deployment"]
 | Node / Artifact | Description
 | hsc plugin binary | compiled version of kbd:[HtmlSC], including required dependencies.
 | hsc-development | where development of kbd:[HtmlSC] takes place
-| artifact repository (https://bintray.com/bintray/jcenter[Bintray]) | global public _cloud_ repository for binary artifacts, similar to https://search.maven.org/[mavenCentral].  kbd:[HtmlSC] binaries are uploaded to this server.
+| 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 kbd:[HtmlSC] plugin to check _some documentation_.
 |===

diff --git a/src/docs/development/publishing.adoc b/src/docs/development/publishing.adoc
@@ -2,10 +2,12 @@
 === Publishing kbd:htmlSC Releases
 
 ==== Automating the Upload of a Gradle Plugin
+// TODO Check this!
 Puh - handling Bintray or JCenter is
 https://java.dzone.com/articles/enjoy-bintray-and-use-it-pain[not funny].
 
 ==== Handling (Secret) Credentials
+// TODO Switch to https://jreleaser.org/[JReleaser]?
 We use Etienne Studers awesome
 https://github.com/etiennestuder/gradle-credentials-plugin[Gradle-Credentials plugin]
 to allow automatic deployment to public portals (like Bintray, JCenter and/or Gradle-Plugin-Portal)

diff --git a/src/docs/ea/readme.ad b/src/docs/ea/readme.ad
@@ -5,8 +5,7 @@ Please note that these are generated files but reside in the `src`-folder in ord
 
 This is to make sure that they can be used from environments other than windows.
 
-# Warning!
+[WARNING]
+The contents of this folder	will be overwritten with each re-export!
 
-**The contents of this folder	will be overwritten with each re-export!**
-
-use `gradle exportEA` to re-export files
+use `dtcw exportEA` to re-export files