From 9a66f88f3ce46d2728f816bf6cb1a4deeb5b4004 Mon Sep 17 00:00:00 2001
From: Leon Hoppe <leon@ladenbau-hoppe.de>
Date: Thu, 13 Feb 2025 19:11:06 +0100
Subject: [PATCH] Made documentation ready for production

---
 .gitlab-ci.yml                                | 14 ++++++++
 .idea/.idea.HopFrame/.idea/workspace.xml      | 14 +++-----
 docs/Dockerfile                               | 19 ++++++++++
 docs/Writerside/cfg/buildprofiles.xml         |  2 +-
 docs/Writerside/hopframe.tree                 |  4 +--
 docs/Writerside/redirection-rules.xml         | 36 -------------------
 docs/Writerside/topics/CreateEntityEvent.md   |  3 --
 docs/Writerside/topics/DeleteEntityEvent.md   |  3 --
 docs/Writerside/topics/Events.md              | 22 ++++++------
 .../topics/{starter.md => Overview.md}        |  0
 docs/Writerside/topics/PageChangeEvent.md     |  3 --
 docs/Writerside/topics/ReloadEvent.md         |  3 --
 docs/Writerside/topics/SearchEvent.md         |  3 --
 docs/Writerside/topics/SelectEntityEvent.md   |  3 --
 .../topics/TableInitializedEvent.md           |  3 --
 docs/Writerside/topics/UpdateEntityEvent.md   |  3 --
 docs/Writerside/topics/ValidationEvent.md     |  3 --
 docs/Writerside/writerside.cfg                |  2 +-
 .../HopFrameConfiguratorExtensions.cs         |  5 +++
 19 files changed, 58 insertions(+), 87 deletions(-)
 create mode 100644 docs/Dockerfile
 delete mode 100644 docs/Writerside/topics/CreateEntityEvent.md
 delete mode 100644 docs/Writerside/topics/DeleteEntityEvent.md
 rename docs/Writerside/topics/{starter.md => Overview.md} (100%)
 delete mode 100644 docs/Writerside/topics/PageChangeEvent.md
 delete mode 100644 docs/Writerside/topics/ReloadEvent.md
 delete mode 100644 docs/Writerside/topics/SearchEvent.md
 delete mode 100644 docs/Writerside/topics/SelectEntityEvent.md
 delete mode 100644 docs/Writerside/topics/TableInitializedEvent.md
 delete mode 100644 docs/Writerside/topics/UpdateEntityEvent.md
 delete mode 100644 docs/Writerside/topics/ValidationEvent.md

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 9b68d7f..1c156ac 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,6 +4,7 @@ stages:
   - build
   - test
   - publish
+  - publish-help
 
 before_script:
   - echo "Setting up environment"
@@ -37,3 +38,16 @@ publish:
   dependencies:
     - build
     - test
+
+publish-help:
+  stage: publish-help
+  script:
+    - export VERSION=$(echo $CI_COMMIT_TAG | sed 's/^v//')
+    - docker login -u leon.hoppe -p ${CI_REGISTRY_PASSWORD} registry.leon-hoppe.de
+    - docker build -t registry.leon-hoppe.de/leon.hoppe/hopframe:$VERSION -t registry.leon-hoppe.de/leon.hoppe/hopframe:latest .
+    - docker push registry.leon-hoppe.de/leon.hoppe/hopframe:$VERSION
+    - docker push registry.leon-hoppe.de/leon.hoppe/hopframe:latest
+  only:
+    - tags
+  dependencies:
+    - publish
diff --git a/.idea/.idea.HopFrame/.idea/workspace.xml b/.idea/.idea.HopFrame/.idea/workspace.xml
index 8aef8b9..0de882e 100644
--- a/.idea/.idea.HopFrame/.idea/workspace.xml
+++ b/.idea/.idea.HopFrame/.idea/workspace.xml
@@ -12,15 +12,10 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="0648788e-7696-4e60-bf12-5d5601f33d8c" name="Changes" comment="">
-      <change afterPath="$PROJECT_DIR$/docs/Writerside/images/dashboard.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/docs/Writerside/images/editor.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/docs/Writerside/images/table.png" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/testing/HopFrame.Testing/AuthService.cs" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/.idea.HopFrame/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/.idea.HopFrame/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs/Writerside/topics/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/Writerside/topics/Dashboard.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docs/Writerside/topics/Table.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/Writerside/topics/Table.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/HopFrame.Core/Config/HopFrameConfig.cs" beforeDir="false" afterPath="$PROJECT_DIR$/src/HopFrame.Core/Config/HopFrameConfig.cs" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/testing/HopFrame.Testing/Program.cs" beforeDir="false" afterPath="$PROJECT_DIR$/testing/HopFrame.Testing/Program.cs" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/docs/Dockerfile" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/Writerside/hopframe.tree" beforeDir="false" afterPath="$PROJECT_DIR$/docs/Writerside/hopframe.tree" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/Writerside/topics/starter.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/Writerside/topics/Overview.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs" beforeDir="false" afterPath="$PROJECT_DIR$/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -252,6 +247,7 @@
       <workItem from="1739301922710" duration="33000" />
       <workItem from="1739352479748" duration="3047000" />
       <workItem from="1739369355001" duration="1751000" />
+      <workItem from="1739461452173" duration="5533000" />
     </task>
     <task id="LOCAL-00001" summary="Added basic configuration">
       <option name="closed" value="true" />
diff --git a/docs/Dockerfile b/docs/Dockerfile
new file mode 100644
index 0000000..ee0a50d
--- /dev/null
+++ b/docs/Dockerfile
@@ -0,0 +1,19 @@
+FROM jetbrains/writerside-builder:243.22562 AS build
+
+ARG INSTANCE=Writerside/hopframe
+
+RUN mkdir /opt/sources
+
+WORKDIR /opt/sources
+
+ADD Writerside ./Writerside
+
+RUN export DISPLAY=:99 && Xvfb :99 & /opt/builder/bin/idea.sh helpbuilderinspect --source-dir /opt/sources --product $INSTANCE --runner other --output-dir /opt/wrs-output/
+
+WORKDIR /opt/wrs-output
+
+RUN unzip -O UTF-8 webHelpHOPFRAME2-all.zip -d /opt/wrs-output/unzipped-artifact
+
+FROM httpd:2.4 AS http-server
+
+COPY --from=build /opt/wrs-output/unzipped-artifact/ /usr/local/apache2/htdocs/
\ No newline at end of file
diff --git a/docs/Writerside/cfg/buildprofiles.xml b/docs/Writerside/cfg/buildprofiles.xml
index 9b254c1..ce856dd 100644
--- a/docs/Writerside/cfg/buildprofiles.xml
+++ b/docs/Writerside/cfg/buildprofiles.xml
@@ -3,8 +3,8 @@
 <buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
-    <variables></variables>
     <build-profile instance="hopframe">
+        <sitemap priority="0.35" change-frequency="monthly"/>
         <variables>
             <noindex-content>false</noindex-content>
         </variables>
diff --git a/docs/Writerside/hopframe.tree b/docs/Writerside/hopframe.tree
index db30f7f..3afb72e 100644
--- a/docs/Writerside/hopframe.tree
+++ b/docs/Writerside/hopframe.tree
@@ -4,9 +4,9 @@
 
 <instance-profile id="hopframe"
                  name="HopFrame"
-                 start-page="starter.md">
+                 start-page="Overview.md">
 
-    <toc-element topic="starter.md"/>
+    <toc-element topic="Overview.md"/>
     <toc-element topic="Installation.md"/>
     <toc-element topic="Authentication.md"/>
     <toc-element toc-title="Core Module">
diff --git a/docs/Writerside/redirection-rules.xml b/docs/Writerside/redirection-rules.xml
index d0f1a50..c7e960a 100644
--- a/docs/Writerside/redirection-rules.xml
+++ b/docs/Writerside/redirection-rules.xml
@@ -6,40 +6,4 @@
         <accepts>page.html</accepts>
     </rule>
     -->
-    <rule id="50095ff3">
-        <description>Created after removal of "SelectEntityEvent" from HopFrame</description>
-        <accepts>SelectEntityEvent.html</accepts>
-    </rule>
-    <rule id="7d9a1af8">
-        <description>Created after removal of "UpdateEntityEvent" from HopFrame</description>
-        <accepts>UpdateEntityEvent.html</accepts>
-    </rule>
-    <rule id="701228d0">
-        <description>Created after removal of "CreateEntityEvent" from HopFrame</description>
-        <accepts>CreateEntityEvent.html</accepts>
-    </rule>
-    <rule id="4b4c2b45">
-        <description>Created after removal of "DeleteEntityEvent" from HopFrame</description>
-        <accepts>DeleteEntityEvent.html</accepts>
-    </rule>
-    <rule id="39604ad3">
-        <description>Created after removal of "TableInitializedEvent" from HopFrame</description>
-        <accepts>TableInitializedEvent.html</accepts>
-    </rule>
-    <rule id="2d6b7079">
-        <description>Created after removal of "PageChangeEvent" from HopFrame</description>
-        <accepts>PageChangeEvent.html</accepts>
-    </rule>
-    <rule id="6933278d">
-        <description>Created after removal of "ReloadEvent" from HopFrame</description>
-        <accepts>ReloadEvent.html</accepts>
-    </rule>
-    <rule id="2043e755">
-        <description>Created after removal of "SearchEvent" from HopFrame</description>
-        <accepts>SearchEvent.html</accepts>
-    </rule>
-    <rule id="2dee3925">
-        <description>Created after removal of "ValidationEvent" from HopFrame</description>
-        <accepts>ValidationEvent.html</accepts>
-    </rule>
 </rules>
\ No newline at end of file
diff --git a/docs/Writerside/topics/CreateEntityEvent.md b/docs/Writerside/topics/CreateEntityEvent.md
deleted file mode 100644
index 6e5b747..0000000
--- a/docs/Writerside/topics/CreateEntityEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# CreateEntityEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/DeleteEntityEvent.md b/docs/Writerside/topics/DeleteEntityEvent.md
deleted file mode 100644
index 5229501..0000000
--- a/docs/Writerside/topics/DeleteEntityEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# DeleteEntityEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/Events.md b/docs/Writerside/topics/Events.md
index 622d8df..d8c6e20 100644
--- a/docs/Writerside/topics/Events.md
+++ b/docs/Writerside/topics/Events.md
@@ -14,7 +14,7 @@ public abstract class HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **Sender**: The sender of the event.
     - **Type:** `TSender`
@@ -23,7 +23,7 @@ public abstract class HopFrameEventArgs {
 - **Table**: The table configuration related to the event.
     - **Type:** `TableConfig`
 
-### Methods
+**Methods:**
 
 - **SetCancelled**
     - **Parameters:**
@@ -40,7 +40,7 @@ public sealed class DeleteEntryEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **Entity**: The entity being deleted.
     - **Type:** `object`
@@ -65,7 +65,7 @@ public sealed class UpdateEntryEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **Entity**: The entity being updated.
     - **Type:** `object`
@@ -81,7 +81,7 @@ public sealed class SelectEntryEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **Entity**: The entity being selected.
     - **Type:** `object`
@@ -100,7 +100,7 @@ public sealed class PageChangeEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **CurrentPage**: The current page number.
     - **Type:** `int`
@@ -132,7 +132,7 @@ public sealed class SearchEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **SearchTerm**: The search term used.
     - **Type:** `string`
@@ -143,7 +143,7 @@ public sealed class SearchEvent : HopFrameEventArgs {
 - **TotalPages**: The total number of pages of search results.
     - **Type:** `int`
 
-### Methods
+**Methods:**
 
 - **SetSearchResult**
     - **Parameters:**
@@ -172,14 +172,14 @@ public class TableInitializedEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **PluginButtons**: The list of plugin buttons for the table.
     - **Type:** `List<PluginButton>`
 - **DefaultButtons**: The default button toggles for the table.
     - **Type:** `DefaultButtonToggles`
 
-### Methods
+**Methods:**
 
 - **AddPageButton**
     - **Parameters:**
@@ -206,7 +206,7 @@ public sealed class ValidationEvent : HopFrameEventArgs {
 }
 ```
 
-### Properties
+**Properties:**
 
 - **Errors**: The list of validation errors.
     - **Type:** `IList<string>`
diff --git a/docs/Writerside/topics/starter.md b/docs/Writerside/topics/Overview.md
similarity index 100%
rename from docs/Writerside/topics/starter.md
rename to docs/Writerside/topics/Overview.md
diff --git a/docs/Writerside/topics/PageChangeEvent.md b/docs/Writerside/topics/PageChangeEvent.md
deleted file mode 100644
index e1b898c..0000000
--- a/docs/Writerside/topics/PageChangeEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# PageChangeEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/ReloadEvent.md b/docs/Writerside/topics/ReloadEvent.md
deleted file mode 100644
index c26c3d5..0000000
--- a/docs/Writerside/topics/ReloadEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# ReloadEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/SearchEvent.md b/docs/Writerside/topics/SearchEvent.md
deleted file mode 100644
index 3d2bb04..0000000
--- a/docs/Writerside/topics/SearchEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# SearchEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/SelectEntityEvent.md b/docs/Writerside/topics/SelectEntityEvent.md
deleted file mode 100644
index d93af02..0000000
--- a/docs/Writerside/topics/SelectEntityEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# SelectEntityEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/TableInitializedEvent.md b/docs/Writerside/topics/TableInitializedEvent.md
deleted file mode 100644
index 02b205b..0000000
--- a/docs/Writerside/topics/TableInitializedEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# TableInitializedEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/UpdateEntityEvent.md b/docs/Writerside/topics/UpdateEntityEvent.md
deleted file mode 100644
index 745fcf6..0000000
--- a/docs/Writerside/topics/UpdateEntityEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# UpdateEntityEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/topics/ValidationEvent.md b/docs/Writerside/topics/ValidationEvent.md
deleted file mode 100644
index f5563a3..0000000
--- a/docs/Writerside/topics/ValidationEvent.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# ValidationEvent
-
-Start typing here...
\ No newline at end of file
diff --git a/docs/Writerside/writerside.cfg b/docs/Writerside/writerside.cfg
index bf534b9..31b887a 100644
--- a/docs/Writerside/writerside.cfg
+++ b/docs/Writerside/writerside.cfg
@@ -7,5 +7,5 @@
     <images dir="images" web-path="images"/>
     <categories src="c.list"/>
     <vars src="v.list"/>
-    <instance src="hopframe.tree" version="3.2.0"/>
+    <instance src="hopframe.tree"/>
 </ihp>
\ No newline at end of file
diff --git a/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs b/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs
index 7ebe959..01fb2ef 100644
--- a/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs
+++ b/src/HopFrame.Web/HopFrameConfiguratorExtensions.cs
@@ -33,6 +33,11 @@ public static class HopFrameConfiguratorExtensions {
         return configurator;
     }
 
+    /// <summary>
+    /// Registers a plugin
+    /// </summary>
+    /// <param name="configurator">The configurator for the HopFrame config that is being created</param>
+    /// <typeparam name="TPlugin">The plugin that should be registered</typeparam>
     public static HopFrameConfigurator AddPlugin<TPlugin>(this HopFrameConfigurator configurator) where TPlugin : HopFramePlugin {
         PluginOrchestrator.RegisterPlugin(configurator.ServiceCollection, typeof(TPlugin));