Merge branch '5.x' into patch-1

Author: adiati98

.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"
 }

.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+{
+    "features": {
+        "ghcr.io/devcontainers/features/python:1": {
+            "version": "3.11",
+            "installTools": true
+        }
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "swyddfa.esbonio",
+                "lextudio.restructuredtext",
+                "eamodio.gitlens",
+                "trond-snekvik.simple-rst"
+            ]
+        }
+    },
+    "postCreateCommand": "chmod +x .devcontainer/setup-project.sh && .devcontainer/setup-project.sh"
+}

.devcontainer/setup-project.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -ex
+
+VALE_VERSION=3.7.1
+
+# Install required packages
+pip install -r docs/requirements.txt
+
+# Required for Vale
+pip install rst2html rstcheck
+
+# Install Vale
+mkdir -p /tmp/vale
+curl -sSL https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz | tar -xz -C /tmp/vale
+sudo install -o root -g root -m 0755 /tmp/vale/vale /usr/local/bin/vale
+rm -rf /tmp/vale

.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
@@ -22,8 +23,10 @@ CCPA
 Citrix
 Clearbit
 CloudAMQP
+Codeception
 Codecov
 Company(ies)
+Composability
 Composer
 Config
 config
@@ -47,8 +50,6 @@ Firewalls
 firewalls
 Focus Item
 Focus Items
-Forms
-forms
 Froala
 Froogaloop
 gcm
@@ -70,6 +71,8 @@ HubSpot
 IDP
 IMAP
 infographics
+Initialisms
+initialisms
 ISO
 JavaScript
 Joomla
@@ -108,6 +111,8 @@ Plugin
 Plugins
 post
 POST
+ProTip
+ProTips
 PUT
 PyCharm
 Rackspace
@@ -137,7 +142,6 @@ Themes
 timeframe
 Todo
 tooltip
-Tooltip
 Transifex
 Translator
 TRUE
@@ -156,6 +160,7 @@ Vtiger
 Webhooks
 Webmecanik
 www
+XPath
 YAML
 Zapier
 Zoho

.github/workflows/dev_merge_pr.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

.github/workflows/dev_validate_pr.yml

@@ -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
 

.github/workflows/linting.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