Automated deployment: Mon Nov 18 10:38:29 UTC 2024 0.1.12

dotkernel · Nov 18, 2024 · f190205 · f190205
1 parent 9d05740
commit f190205
Show file tree

Hide file tree

Showing 23 changed files with 70 additions and 55 deletions.
diff --git a/index.html b/index.html
@@ -293,7 +293,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="v5/installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="v5/installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -589,5 +589,5 @@ <h5 class="modal-title">Search</h5>
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2024-11-12 10:21:33.507957+00:00
+Build Date UTC : 2024-11-18 10:38:28.604817+00:00
 -->
diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,82 +2,82 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/account-anonymization/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/authorization/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/creating-fixtures/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/creating-migrations/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/csrf/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/dependency-injection/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/how-to/npm_commands/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/composer/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/configuration-files/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/development-mode/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/doctrine-orm/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/faq/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/getting-started/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/installation-intro/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/installation/running-application/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/introduction/file-structure/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/introduction/introduction/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/introduction/packages/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
     <url>
          <loc>https://docs.dotkernel.org/frontend-documentation/v5/introduction/server-requirements/</loc>
-         <lastmod>2024-11-12</lastmod>
+         <lastmod>2024-11-18</lastmod>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/v5/how-to/account-anonymization/index.html b/v5/how-to/account-anonymization/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/authorization/index.html b/v5/how-to/authorization/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/creating-fixtures/index.html b/v5/how-to/creating-fixtures/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/creating-migrations/index.html b/v5/how-to/creating-migrations/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/csrf/index.html b/v5/how-to/csrf/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/dependency-injection/index.html b/v5/how-to/dependency-injection/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/how-to/npm_commands/index.html b/v5/how-to/npm_commands/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/installation/composer/index.html b/v5/installation/composer/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -442,7 +442,7 @@ <h6 class="toc__headline">On this page</h6>
 
 
     <h1 id="composer-installation-of-packages">Composer Installation of Packages</h1>
-<p>Composer is required to install Dotkernel <code>frontend</code>. You can install Composer from the <a href="https://getcomposer.org/">official site</a>.</p>
+<p>Composer is required to install Dotkernel Frontend. You can install Composer from the <a href="https://getcomposer.org/">official site</a>.</p>
 <blockquote>
 <p>First make sure that you have navigated your command prompt to the folder where you copied the files in the previous step.</p>
 </blockquote>

diff --git a/v5/installation/configuration-files/index.html b/v5/installation/configuration-files/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -456,7 +456,8 @@ <h2 id="prepare-config-files">Prepare config files</h2>
 <li>Edit <code>config/autoload/local.php</code> according to your dev machine and fill in the <code>database</code> configuration.</li>
 </ul>
 <blockquote>
-<p>If you intend to send emails from your Frontend, make sure to fill in SMTP connection params. This will be covered in the next section.</p>
+<p>If you intend to send emails from your Frontend, make sure to fill in SMTP connection params.
+This will be covered in the next section.</p>
 <p><strong>Optional</strong>: in order to run/create tests, duplicate <code>config/autoload/local.test.php.dist</code> as <code>config/autoload/local.test.php</code>.
 This creates a new in-memory database that your tests will run on.</p>
 </blockquote>

diff --git a/v5/installation/development-mode/index.html b/v5/installation/development-mode/index.html
@@ -22,7 +22,7 @@
 
         <link rel="shortcut icon" href="https://docs.dotkernel.org/img/dk_docs_favicon_white.svg">
 
-        <title>Development Mode and the Debugbar - frontend - DotKernel Documentation</title>
+        <title>Development Mode - frontend - DotKernel Documentation</title>
 
         <link rel="stylesheet" href="https://docs.dotkernel.org/css/bootstrap.css">
         <link rel="stylesheet" href="https://docs.dotkernel.org/css/bootstrap-icons.min.css">
@@ -163,7 +163,7 @@
 
 
 
-                    <li class="breadcrumb-item active" aria-current="page">Development Mode and the Debugbar</li>
+                    <li class="breadcrumb-item active" aria-current="page">Development Mode</li>
 
 
         </ol>
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item subnavigation__list-item--active">
-    <a href="./" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="./" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/installation/doctrine-orm/index.html b/v5/installation/doctrine-orm/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -519,7 +519,7 @@ <h2 id="fixtures">Fixtures</h2>
 
                 <a rel="next" class="page-nav__link page-nav__link--next" href="../development-mode/">
                     <small class="page-nav__label">Next</small>
-                    Development Mode and the Debugbar
+                    Development Mode
                     <i class="bi bi-chevron-right"></i>
                 </a>
 

diff --git a/v5/installation/faq/index.html b/v5/installation/faq/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/installation/getting-started/index.html b/v5/installation/getting-started/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/installation/installation-intro/index.html b/v5/installation/installation-intro/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 

diff --git a/v5/installation/running-application/index.html b/v5/installation/running-application/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -465,7 +465,7 @@ <h1 id="running-the-application">Running the application</h1>
                 <a rel="prev" class="page-nav__link page-nav__link--prev" href="../development-mode/">
                     <small class="page-nav__label">Previous</small>
                     <i class="bi bi-chevron-left"></i>
-                    Development Mode and the Debugbar
+                    Development Mode
                 </a>
 
         </li>

diff --git a/v5/introduction/file-structure/index.html b/v5/introduction/file-structure/index.html
@@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -428,7 +428,7 @@ <h6 class="toc__headline">On this page</h6>
                 </li>
 
                 <li class="toc__entry">
-                    <a href="#templates-directory" class="toc__link nav-link">templates directory</a>
+                    <a href="#templates-directory-for-modules" class="toc__link nav-link">templates directory for modules</a>
                 </li>
 
                 <li class="toc__entry">
@@ -455,15 +455,14 @@ <h6 class="toc__headline">On this page</h6>
 
     <h1 id="file-structure">File structure</h1>
 <p>Dotkernel Frontend follows the <a href="https://www.php-fig.org/psr/psr-4/">PSR-4</a> standards.</p>
-<p>It is a good practice to standardize the file structure of projects.</p>
+<p>It is considered good practice to standardize the file structure of projects.</p>
 <p>When using Dotkernel Frontend the following structure is installed by default:</p>
 <p><img alt="Dotkernel Frontend File Structure!" src="https://docs.dotkernel.org/img/frontend/file-structure-dk-frontend.png" class="img-responsive"/></p>
 <h2 id="main-directories">Main directories</h2>
 <ul>
 <li><code>bin</code> - Executable files from CLI</li>
 <li><code>config</code> - Various configuration files</li>
 <li><code>data</code> - Should contain project-related data (AVOID storing sensitive data on VCS)</li>
-<li><code>documentation</code> - Should contain project-related documentation</li>
 <li><code>log</code> - Storage of log files generated by dot-error-log library</li>
 <li><code>public</code> - Publicly visible files. The webserver need to have this folder as www-document root folder.</li>
 <li><code>src</code> - Should contain the source code files</li>
@@ -476,7 +475,7 @@ <h2 id="special-purpose-folders">Special purpose folders</h2>
 </ul>
 <h2 id="src-directory"><code>src</code> directory</h2>
 <p>This directory contains all source code related to the Module.
-It should contain the following directories, if they’re not empty:</p>
+It should contain the following directories, if they are not empty:</p>
 <ul>
 <li>Handler - Action classes (similar to Controllers but can only perform one action)</li>
 <li>Entity - Database entities</li>
@@ -493,7 +492,7 @@ <h2 id="src-directory"><code>src</code> directory</h2>
 <li><code>ConfigProvider.php</code> - Provides configuration data</li>
 <li><code>RoutesDelegator.php</code> - Module main routes entry file</li>
 </ul>
-<h2 id="templates-directory"><code>templates</code> directory</h2>
+<h2 id="templates-directory-for-modules"><code>templates</code> directory for modules</h2>
 <p>This directory contains the template files, used for example to help render e-mail templates.</p>
 <blockquote>
 <p>Dotkernel Frontend uses <code>twig</code> as Templating Engine.

diff --git a/v5/introduction/introduction/index.html b/v5/introduction/introduction/index.html
@@ -302,7 +302,7 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 <li class="subnavigation__list-item ">
-    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+    <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
 </li>
 
 
@@ -417,8 +417,23 @@ <h5 class="subnavigation__title">Table of Contents</h5>
 
 
 
-    <h1 id="frontend">frontend</h1>
-<p>Dotkernel web starter package suitable for frontend applications.</p>
+    <h1 id="introduction">Introduction</h1>
+<p>Dotkernel Frontend is an application (skeleton) based on Mezzio microframework using Laminas components.
+It's designed as a web starter package suitable for frontend applications.
+The current functionality is included as a proof of concept and to showcase Frontend's file architecture:</p>
+<ul>
+<li>Contact us page</li>
+<li>Generic page with copy</li>
+<li>User accounts</li>
+</ul>
+<p>Use these building blocks as an example for your own custom code.</p>
+<p>Read on to find out more about the application:</p>
+<ul>
+<li>A technical <strong>overview</strong> to understand technical requirements and included packages</li>
+<li>A step-by-step <strong>installation</strong> guide to get you up and running in minutes</li>
+<li>Detailed <strong>how-tos</strong> for working with the current features</li>
+</ul>
+<p>Check out our <a href="https://v5.dotkernel.net/">demo</a>.</p>
 <p><img alt="OSS Lifecycle" src="https://img.shields.io/osslifecycle/dotkernel/frontend" />
 <img alt="PHP from Packagist (specify version)" src="https://img.shields.io/packagist/php-v/dotkernel/frontend/4.2.0" /></p>
 <p><a href="https://github.com/dotkernel/frontend/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/dotkernel/frontend" /></a>
-Original file line number
+Diff line change
@@ Expand Up / @@ -309,7 +309,7 @@ <h5 class="subnavigation__title">Table of Contents</h5> @@
     <li class="subnavigation__list-item ">
-        <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode and the Debugbar</a>
+        <a href="../../installation/development-mode/" class="subnavigation__link">Development Mode</a>
     </li>
@@ Expand Down @@