Merge branch '5.x' into docs-quick_filters

Author: RCheesley

.all-contributorsrc

@@ -32,6 +32,33 @@
         "doc",
         "review"
       ]
+    },
+    {
+      "login": "ifeoluwafavour",
+      "name": "Ife",
+      "avatar_url": "https://avatars.githubusercontent.com/u/64481442?v=4",
+      "profile": "http://ifeoluwafavour.hashnode.dev",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "sumbria",
+      "name": "Balbinder Sumbria",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6416992?v=4",
+      "profile": "https://incodit.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Hugo-Prossaird",
+      "name": "Hugo-Prossaird",
+      "avatar_url": "https://avatars.githubusercontent.com/u/176997845?v=4",
+      "profile": "https://github.com/Hugo-Prossaird",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,
@@ -40,5 +67,6 @@
   "repoType": "github",
   "repoHost": "https://github.com",
   "skipCi": true,
-  "commitConvention": "angular"
+  "commitConvention": "angular",
+  "commitType": "docs"
 }

.github/holopin.yml

@@ -0,0 +1,5 @@
+ organization: mautic
+holobytes:
+  - evolvingStickerId: cm1ti4x4c57560cjq2styaitm
+    icon: avocado
+    alias: hacktoberfest-2024

.github/styles/Vocab/Mautic/accept.txt renamed to .github/styles/config/vocabularies/Mautic/accept.txt

@@ -2,6 +2,7 @@ AJAX
 allowlist
 Amazon SES
 Ameling
+ascenders
 autoloader
 Autoloader
 autowire
@@ -25,6 +26,7 @@ CloudAMQP
 Codeception
 Codecov
 Company(ies)
+Composability
 Composer
 Config
 config
@@ -48,8 +50,6 @@ Firewalls
 firewalls
 Focus Item
 Focus Items
-Forms
-forms
 Froala
 Froogaloop
 gcm
@@ -71,6 +71,8 @@ HubSpot
 IDP
 IMAP
 infographics
+Initialisms
+initialisms
 ISO
 JavaScript
 Joomla
@@ -138,7 +140,6 @@ Themes
 timeframe
 Todo
 tooltip
-Tooltip
 Transifex
 Translator
 TRUE

.github/workflows/linting.yml

@@ -4,48 +4,49 @@ on:
 
 jobs:
   prose:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04  # See https://github.com/errata-ai/vale-action/issues/128 before upgrading
+    permissions:
+      contents: read
+      pull-requests: write
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
-        cache: 'pip'
-
-    - name: Install Python dependencies
-      run: pip3 install -r docs/requirements.txt
-
-    - name: Vale
-      uses: errata-ai/vale-action@reviewdog
-      with:
-        # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
-        version: 2.29.2
-        fail_on_error: true
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: pip3 install -r docs/requirements.txt
+
+      - name: Vale
+        uses: errata-ai/vale-action@reviewdog
+        with:
+          version: 3.7.1  # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
-        cache: 'pip'
-
-    - name: Install Python dependencies
-      run: pip3 install -r docs/requirements.txt
-
-    - name: Build docs
-      working-directory: docs
-      run: make html
-
-    - name: Check links
-      working-directory: docs
-      run: make checklinks
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: pip3 install -r docs/requirements.txt
+      
+      - name: Build docs
+        working-directory: docs
+        run: make html
+
+      - name: Check links
+        working-directory: docs
+        run: make checklinks

.gitpod.Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.11
 
 # Don't update to a higher version until this issue has been fixed: https://github.com/errata-ai/vale/issues/528
 # Please keep version in sync with the version in .github/workflows/linting.yml for a consistent experience
-ENV VALE_VERSION=2.29.2
+ENV VALE_VERSION=3.7.1
 
 WORKDIR /workspace
 

.gitpod.yml

@@ -1,6 +1,5 @@
-# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily
-# use this once which has Python 3.9 and Vale preinstalled.
-image: dennisameling/python-vale:latest
+image: 
+  file: .gitpod.Dockerfile
 
 tasks:
   - before: pip install -r docs/requirements.txt
@@ -9,7 +8,9 @@ tasks:
 vscode:
   extensions:
     - ms-python.python
-    - lextudio.restructuredtext
-    - errata-ai.vale-server
+    - [email protected] # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading.    - errata-ai.vale-server
     - eamodio.gitlens
     - trond-snekvik.simple-rst
+
+ports:
+  - port: 3000

.vscode/settings.json

@@ -5,5 +5,8 @@
     "esbonio.sphinx.confDir": "${workspaceFolder}/docs",
     "restructuredtext.pythonRecommendation.disabled": true,
     "restructuredtext.preview.name": "sphinx",
+    "esbonio.sphinx.pythonCommand": "python3",
+    "esbonio.sphinx.buildCommand": "sphinx-build",
+    "esbonio.logging.level": "debug",
     "gitlens.showWhatsNewAfterUpgrades": false
 }

.well-known/funding-manifest-urls

@@ -0,0 +1 @@
+https://github.com/mautic/mautic/blob/5.x/funding.json

README.md

@@ -1,6 +1,6 @@
 [![Documentation Status][RTD badge URL]][RTD URL]
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mautic/developer-documentation-new)
@@ -120,9 +120,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <table>
   <tbody>
     <tr>
-      <td align="center"><a href="https://robert-parker.me"><img src="https://avatars.githubusercontent.com/u/25473863?v=4?s=100" width="100px;" alt="Robert Parker"/><br /><sub><b>Robert Parker</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=diaboloshogunate" title="Documentation">📖</a></td>
-      <td align="center"><a href="https://github.com/shinde-rahul"><img src="https://avatars.githubusercontent.com/u/1046788?v=4?s=100" width="100px;" alt="Rahul Shinde"/><br /><sub><b>Rahul Shinde</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=shinde-rahul" title="Documentation">📖</a></td>
-      <td align="center"><a href="https://dennisameling.com"><img src="https://avatars.githubusercontent.com/u/17739158?v=4?s=100" width="100px;" alt="Dennis Ameling"/><br /><sub><b>Dennis Ameling</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=dennisameling" title="Documentation">📖</a> <a href="https://github.com/mautic/developer-documentation-new/pulls?q=is%3Apr+reviewed-by%3Adennisameling" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://robert-parker.me"><img src="https://avatars.githubusercontent.com/u/25473863?v=4?s=100" width="100px;" alt="Robert Parker"/><br /><sub><b>Robert Parker</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=diaboloshogunate" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/shinde-rahul"><img src="https://avatars.githubusercontent.com/u/1046788?v=4?s=100" width="100px;" alt="Rahul Shinde"/><br /><sub><b>Rahul Shinde</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=shinde-rahul" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://dennisameling.com"><img src="https://avatars.githubusercontent.com/u/17739158?v=4?s=100" width="100px;" alt="Dennis Ameling"/><br /><sub><b>Dennis Ameling</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=dennisameling" title="Documentation">📖</a> <a href="https://github.com/mautic/developer-documentation-new/pulls?q=is%3Apr+reviewed-by%3Adennisameling" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://ifeoluwafavour.hashnode.dev"><img src="https://avatars.githubusercontent.com/u/64481442?v=4?s=100" width="100px;" alt="Ife"/><br /><sub><b>Ife</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=ifeoluwafavour" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://incodit.com"><img src="https://avatars.githubusercontent.com/u/6416992?v=4?s=100" width="100px;" alt="Balbinder Sumbria"/><br /><sub><b>Balbinder Sumbria</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=sumbria" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Hugo-Prossaird"><img src="https://avatars.githubusercontent.com/u/176997845?v=4?s=100" width="100px;" alt="Hugo-Prossaird"/><br /><sub><b>Hugo-Prossaird</b></sub></a><br /><a href="https://github.com/mautic/developer-documentation-new/commits?author=Hugo-Prossaird" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

docs/components/cache.rst

@@ -43,6 +43,7 @@ All you need to do now is to clear all tagged items:
 .. code-block:: php
 
     $cache->invalidateTags(['firstTag']);
+
 Pools clearing
 ==============
 
@@ -54,6 +55,7 @@ Cache Pools include methods to delete a cache item, some of them, or all of them
 .. code-block:: php
 
     $isDeleted = $cache->deleteItem('user_'.$userId);
+
 Use the ``Psr\\Cache\\CacheItemPoolInterface::deleteItems`` method to delete several cache items simultaneously - it returns true only if all the items have been deleted, even when any or some of them don't exist.
 
 Configuration
@@ -68,6 +70,7 @@ These are the default settings:
     'cache_adapter' => 'mautic.cache.adapter.filesystem',
     'cache_prefix' => 'app',
     'cache_lifetime' => 86400
+
 They can be overridden in ``local.php`` like this:
 
 .. code-block:: php
@@ -84,6 +87,7 @@ Delivered adapters
 - ``mautic.cache.adapter.memcached``
 
 .. code-block:: php
+    
     'memcached' => [
         'servers' => ['memcached://localhost'],
         'options' => [