Merge branch '2.1.x' into 2.2.x

Author: DavidBadura

.github/workflows/docs-build.yml

@@ -32,21 +32,21 @@ jobs:
 
       - name: Find latest release
         id: latest_release
-        uses: pozetroninc/github-action-get-latest-release@v0.6.0
+        uses: pozetroninc/github-action-get-latest-release@v0.8.0
         with:
           repository: ${{ github.repository }}
-          excludes: draft
+          excludes: draft,prerelease
 
       - name: Normalize current versions
         id: current
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: return context.ref.match(/([0-9]+\.[0-9]+)\.(x|[0-9]+)/i)[1];
           result-encoding: string
 
       - name: Normalize latest versions
         id: latest
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: return "${{steps.latest_release.outputs.release}}".match(/([0-9]+\.[0-9]+)\.[0-9]+/i)[1];
           result-encoding: string

Makefile

@@ -40,3 +40,11 @@ test: phpunit
 
 .PHONY: dev
 dev: static test                                                                ## run dev tools
+
+.PHONY: docs
+docs: mkdocs                                                                          ## run mkdocs
+	cd docs && python3 -m mkdocs serve
+
+.PHONY: mkdocs
+mkdocs:                                                                         ## run mkdocs
+	cd docs && pip3 install -r requirements.txt

docs/mkdocs.yml

@@ -1,6 +1,8 @@
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
 
-site_name: Event Sourcing Bundle
+site_name: Event Sourcing Symfony Bundle
+site_description: A lightweight but also all-inclusive event sourcing bundle with a focus on developer experience and based on doctrine dbal.
+site_author: patchlevel
 site_url: https://patchlevel.github.io/event-sourcing-bundle-docs/
 repo_url: https://github.com/patchlevel/event-sourcing-bundle
 repo_name: patchlevel/event-sourcing-bundle
@@ -9,7 +11,7 @@ docs_dir: pages
 
 extra:
   meta:
-    title: Event Sourcing Bundle
+    title: Event Sourcing Symfony Bundle
     description: A lightweight but also all-inclusive event sourcing bundle with a focus on developer experience and based on doctrine dbal.
     image: img/patchlevel-banner.png
   social:
@@ -21,6 +23,9 @@ extra:
       link: https://twitter.com/patchlevelhq
   version:
     provider: mike
+    alias: true
+  analytics:
+    provider: custom
 
 extra_css:
   - stylesheets/extra.css
@@ -49,6 +54,10 @@ theme:
         icon: material/brightness-4
         name: Switch to light mode
 
+plugins:
+  - mike:
+      canonical_version: latest
+
 markdown_extensions:
   - meta
   - pymdownx.highlight:

docs/overrides/main.html

@@ -2,9 +2,17 @@
 
 {% block extrahead %}
 <meta name="description" content="{{ config.extra.meta.description }}">
+<meta name="keywords" content="event sourcing, php, ddd, symfony" />
 <meta property="og:type" content="website">
 <meta property="og:url" content="{{ config.site_url }}">
 <meta property="og:title" content="{{ config.extra.meta.title }}">
 <meta property="og:description" content="{{ config.extra.meta.description }}">
 <meta property="og:image" content="{{ config.site_url }}{{ config.extra.meta.image }}">
+{% endblock %}
+
+{% block outdated %}
+You're not viewing the latest version.
+<a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+</a>
 {% endblock %}

docs/overrides/partials/integrations/analytics/custom.html

@@ -0,0 +1,13 @@
+<script>
+    var _paq = window._paq = window._paq || [];
+    /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+    _paq.push(['trackPageView']);
+    _paq.push(['enableLinkTracking']);
+    (function() {
+        var u="//matomo.patchlevel.de/";
+        _paq.push(['setTrackerUrl', u+'matomo.php']);
+        _paq.push(['setSiteId', '2']);
+        var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+        g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+    })();
+</script>

docs/requirements.txt

@@ -1,11 +1,11 @@
-mkdocs==1.3.0
-mike==1.1.2
-markdown==3.3.7
-mkdocs-material==8.2.3
+mkdocs==1.5.3
+mike==2.1.1
+markdown==3.6
+mkdocs-material==9.5.18
 
 # Markdown extensions
-Pygments==2.12.0
-pymdown-extensions==9.4
+Pygments==2.18.0
+pymdown-extensions==10.8.1
 
 # MkDocs plugins
-mkdocs-material-extensions==1.0.3
+mkdocs-material-extensions==1.3.1