From 4e6eee77e16ac1cf810e34bf8cae3c0974e22af6 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Tue, 13 Aug 2024 11:28:29 +0200 Subject: [PATCH] #332 Collect design discussions in MicroSite development section --- src/docs/development/_includes/.jbakeignore | 1 + .../{ => _includes}/MainLoop-new.puml | 0 .../development/{ => _includes}/issue-185.adoc | 4 +--- .../development/{ => _includes}/issue-190.adoc | 4 ---- .../development/{ => _includes}/issue-219.adoc | 0 .../development/{ => _includes}/issue-244.adoc | 0 .../development/{ => _includes}/issue-252.adoc | 0 src/docs/development/design-discussions.adoc | 18 ++++++++++++++++++ 8 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 src/docs/development/_includes/.jbakeignore rename src/docs/development/{ => _includes}/MainLoop-new.puml (100%) rename src/docs/development/{ => _includes}/issue-185.adoc (97%) rename src/docs/development/{ => _includes}/issue-190.adoc (98%) rename src/docs/development/{ => _includes}/issue-219.adoc (100%) rename src/docs/development/{ => _includes}/issue-244.adoc (100%) rename src/docs/development/{ => _includes}/issue-252.adoc (100%) create mode 100644 src/docs/development/design-discussions.adoc diff --git a/src/docs/development/_includes/.jbakeignore b/src/docs/development/_includes/.jbakeignore new file mode 100644 index 00000000..8909a95f --- /dev/null +++ b/src/docs/development/_includes/.jbakeignore @@ -0,0 +1 @@ +Do not render these files directly diff --git a/src/docs/development/MainLoop-new.puml b/src/docs/development/_includes/MainLoop-new.puml similarity index 100% rename from src/docs/development/MainLoop-new.puml rename to src/docs/development/_includes/MainLoop-new.puml diff --git a/src/docs/development/issue-185.adoc b/src/docs/development/_includes/issue-185.adoc similarity index 97% rename from src/docs/development/issue-185.adoc rename to src/docs/development/_includes/issue-185.adoc index e48feba7..919937de 100644 --- a/src/docs/development/issue-185.adoc +++ b/src/docs/development/_includes/issue-185.adoc @@ -15,7 +15,7 @@ writing a new checker, especially should there be no central _registry_ of checkers. Up to v 1.0.0-RC-1 we violated the OCP and allowed -major redundancies in code: +major redundancies in the code: [source,java] ---- @@ -33,8 +33,6 @@ class AllCheckers { ---- - - === Solution Approach A solution needs to address two issues: diff --git a/src/docs/development/issue-190.adoc b/src/docs/development/_includes/issue-190.adoc similarity index 98% rename from src/docs/development/issue-190.adoc rename to src/docs/development/_includes/issue-190.adoc index e47d2415..42516371 100644 --- a/src/docs/development/issue-190.adoc +++ b/src/docs/development/_includes/issue-190.adoc @@ -3,7 +3,6 @@ ifndef::plantumldir[:plantumldir: .plantuml/] == Refactoring the Main Checking Loop - https://github.com/aim42/htmlSanityCheck/issues/190[Issue 190] proposes to merge the two classes AllChecksRunner and ChecksRunner. @@ -13,6 +12,3 @@ proposes to merge the two classes AllChecksRunner and ChecksRunner. .... include::MainLoop-new.puml[] .... - - - diff --git a/src/docs/development/issue-219.adoc b/src/docs/development/_includes/issue-219.adoc similarity index 100% rename from src/docs/development/issue-219.adoc rename to src/docs/development/_includes/issue-219.adoc diff --git a/src/docs/development/issue-244.adoc b/src/docs/development/_includes/issue-244.adoc similarity index 100% rename from src/docs/development/issue-244.adoc rename to src/docs/development/_includes/issue-244.adoc diff --git a/src/docs/development/issue-252.adoc b/src/docs/development/_includes/issue-252.adoc similarity index 100% rename from src/docs/development/issue-252.adoc rename to src/docs/development/_includes/issue-252.adoc diff --git a/src/docs/development/design-discussions.adoc b/src/docs/development/design-discussions.adoc new file mode 100644 index 00000000..224a0370 --- /dev/null +++ b/src/docs/development/design-discussions.adoc @@ -0,0 +1,18 @@ +:filename: development/design-decisions.adoc +:jbake-title: Design Discussions +:jbake-type: page_toc +:jbake-status: published +:jbake-menu: development +:jbake-order: 20 +== {jbake-title} +:icons: font +:toc: right +:toclevels: 3 +:toc-position: right +// :experimental: + +include::_includes/issue-185.adoc[leveloffset=+1] +include::_includes/issue-190.adoc[leveloffset=+1] +include::_includes/issue-219.adoc[leveloffset=+1] +include::_includes/issue-244.adoc[leveloffset=+1] +include::_includes/issue-252.adoc[leveloffset=+1] \ No newline at end of file