#343 Unify AsciiDoctor configs

and fix erroneous (missing) links in the Site

Author: ascheman

README.adoc

@@ -1,6 +1,6 @@
 = image:htmlsanitycheck-logo.png[HSC] HTML Sanity Check (HSC)
 :doctype: book
-include::asciidoctor-config.ad[]
+include::src/docs/asciidoctor-config.ad[]
 
 ifndef::xrefToCli[:xrefToCli: htmlSanityCheck-cli/README.adoc]
 ifndef::xrefToGradlePlugin[:xrefToGradlePlugin: htmlSanityCheck-gradle-plugin/README.adoc]

htmlSanityCheck-cli/README.adoc

@@ -1,6 +1,6 @@
 = HSC CLI Module
 :doctype: book
-include::../asciidoctor-config.ad[]
+include::../src/docs/asciidoctor-config.ad[]
 
 ifdef::env-github[]
 :imagesdir: ../src/docs/images

htmlSanityCheck-gradle-plugin/README.adoc

@@ -1,6 +1,6 @@
 = HSC Gradle Plugin
 :doctype: book
-include::../asciidoctor-config.ad[]
+include::../src/docs/asciidoctor-config.ad[]
 
 image:https://img.shields.io/gradle-plugin-portal/v/org.aim42.htmlSanityCheck[link=https://plugins.gradle.org/search?term=org.aim42.htmlSanityCheck]
 image:https://img.shields.io/maven-central/v/org.aim42.htmlSanityCheck/org.aim42.htmlSanityCheck.gradle.plugin[link=https://central.sonatype.com/artifact/org.aim42.htmlSanityCheck/org.aim42.htmlSanityCheck.gradle.plugin]

htmlSanityCheck-maven-plugin/README.adoc

@@ -1,6 +1,6 @@
 = HSC Maven Plugin
 :doctype: book
-include::../asciidoctor-config.ad[]
+include::../src/docs/asciidoctor-config.ad[]
 
 image:https://img.shields.io/maven-central/v/org.aim42.htmlSanityCheck/htmlSanityCheck-maven-plugin[link=https://central.sonatype.com/artifact/org.aim42.htmlSanityCheck/htmlSanityCheck-maven-plugin]
 

integration-test/common/build.gradle

@@ -16,6 +16,7 @@ tasks.register('copyReadmeResources', Copy) {
     }
     from("${projectRoot}/src/docs") {
         include 'images/**'
+        include 'asciidoctor-config.ad'
     }
     into "${Project.DEFAULT_BUILD_DIR_NAME}/docs"
 }

src/docs/arc42/_feedback.adoc

@@ -1,4 +1,7 @@
 ifdef::backend-html5[]
+:project-report-issue-link: {project-issues}/new?title=&body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23page:
+:project-repository-docs-edit-link: {project-url}/edit/develop/src/docs/
+
 image::https://img.shields.io/badge/improve-this%20doc-orange.svg[link={project-repository-docs-edit-link}{filename}, float=right]
 image::https://img.shields.io/badge/create-an%20issue-blue.svg[link="{project-report-issue-link}{filename}", float=right]
 endif::[]

src/docs/arc42/chapters/_config.adoc

@@ -7,25 +7,12 @@
 :email: gernot.starke@innoq.com
 :docdate: {docdate}
 
-// Align the version with
-// - ../../../../gradle.properties file
-// - ../../../../asciidoctor-config.ad
-:hsc-version: 2.0.0-rc5
-
-:project: htmlsanitycheck
+include::../../asciidoctor-config.ad[]
 
 // where are the images located?
 ifndef::imagesdir[:imagesdir: ../images]
 
-:project: htmlSanityCheck
-:project-url: https://github.com/aim42/htmlSanityCheck
-:project-issues: https://github.com/aim42/htmlSanityCheck/issues
-:project-bugs: https://github.com/aim42/htmlSanityCheck/issues?q=is%3Aopen+is%3Aissue+label%3Abug
 :improveDocImage: https://img.shields.io/badge/improve-this%20doc-orange.svg
-:project-name: asciidoctor-gradle-plugin
-:project-report-issue-link: https://github.com/aim42/htmlSanityCheck/issues/new?title=&body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23page:
-:project-repository-docs-link: https://github.com/aim42/htmlSanityCheck/blob/develop/src/docs/
-:project-repository-docs-edit-link: https://github.com/aim42/htmlSanityCheck/edit/develop/src/docs/
 
 ifndef::projectRootDir[:projectRootDir: ../../../..]
 

asciidoctor-config.ad src/docs/asciidoctor-config.adasciidoctor-config.ad renamed to src/docs/asciidoctor-config.ad

@@ -2,9 +2,7 @@
 :toc: left
 ifndef::imagesdir[:imagesdir: src/docs/images]
 
-// Align the version with
-// - ./gradle.properties file
-// - ./src/docs/arc42/chapters/_config.adoc
+// Align the version with ../../gradle.properties file
 :hsc-version: 2.0.0-rc5
 
 :asciidoc-url: https://asciidoctor.org
@@ -15,10 +13,11 @@ ifndef::imagesdir[:imagesdir: src/docs/images]
 :gradle-url: https://gradle.org/
 :jitpack-url: https://jitpack.io/
 :maven-url: https://maven.apache.org/
+
 :project: htmlSanityCheck
 :project-url: https://github.com/aim42/htmlSanityCheck
-:project-bugs: https://github.com/aim42/htmlSanityCheck/issues?q=is%3Aopen+is%3Aissue+label%3Abug
 :project-issues: https://github.com/aim42/htmlSanityCheck/issues
+:project-bugs: {project-issues}?q=is%3Aopen+is%3Aissue+label%3Abug
 
 ifdef::env-github[]
 // Custom GitHub-specific admonition icons

src/docs/development/development-intro.adoc

@@ -12,13 +12,15 @@
 :experimental:
 :imagesdir: ../images
 
+include::../asciidoctor-config.ad[]
+
 === Prerequisites
 
 ==== General Prerequisites
 
 Make yourself familiar with
 
-* The{gradle-url}[Gradle] build system,
+* The {gradle-url}[Gradle] build system,
 * the {maven-url}[Maven] build system,
 * https://jsoup.org/apidocs/[JSoup API documentation].
 

src/docs/index.adoc

@@ -5,12 +5,11 @@ Dr. Gernot Starke <gernot.starke@innoq.com>
 v0.9, 2014-09-02
 :imagesdir: ./images
 :experimental:
-:repositoryDocsDir: https://github.com/aim42/htmlSanityCheck/blob/main/src/docs/
+
+include::asciidoctor-config.ad[]
+
+:repositoryDocsDir: {project-url}/blob/main/src/docs/
 :improveDocImage: https://img.shields.io/badge/improve-this%20doc-orange.svg
-:project: htmlSanityCheck
-:project-url: https://github.com/aim42/htmlSanityCheck
-:project-issues: https://github.com/aim42/htmlSanityCheck/issues
-:project-bugs: "https://github.com/aim42/htmlSanityCheck/issues?q=is%3Aopen+is%3Aissue+label%3Abug"
 
 image::{improveDocImage}[link={repositoryDocsDir}index.adoc, float=right]