Merge Main to 4.x

.all-contributorsrc

@@ -0,0 +1,89 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "gustavokennedy",
+      "name": "Gustavo Kennedy Renkel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/98914036?v=4",
+      "profile": "http://overall.cloud",
+      "contributions": [
+        "translation"
+      ]
+    },
+    {
+      "login": "zaharovrd",
+      "name": "Roman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8171816?v=4",
+      "profile": "http://www.youradman.com",
+      "contributions": [
+        "translation"
+      ]
+    },
+    {
+      "login": "tomekkowalczyk",
+      "name": "Tomasz Kowalczyk",
+      "avatar_url": "https://avatars.githubusercontent.com/u/39382654?v=4",
+      "profile": "http://adevo.pl",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "kukis2107",
+      "name": "kukis2107",
+      "avatar_url": "https://avatars.githubusercontent.com/u/60287846?v=4",
+      "profile": "https://github.com/kukis2107",
+      "contributions": [
+        "translation"
+      ]
+    },
+    {
+      "login": "putzwasser",
+      "name": "putzwasser",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26040044?v=4",
+      "profile": "https://github.com/putzwasser",
+      "contributions": [
+        "review"
+      ]
+    },
+    {
+      "login": "Moongazer",
+      "name": "Moongazer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1685510?v=4",
+      "profile": "https://github.com/Moongazer",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "patrykgruszka",
+      "name": "Patryk Gruszka",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8580942?v=4",
+      "profile": "https://github.com/patrykgruszka",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Amiyah14",
+      "name": "Emily",
+      "avatar_url": "https://avatars.githubusercontent.com/u/45315891?v=4",
+      "profile": "https://github.com/Amiyah14",
+      "contributions": [
+        "doc"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "user-documentation",
+  "projectOwner": "mautic",
+  "commitType": "docs"
+}

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "composer" # See documentation for possible values
+    directory: "/docs" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/styles/Mautic/FeatureList.yml

@@ -39,11 +39,14 @@ swap:
   leads: Contacts
   marketing message: Marketing Message
   marketing messages: Marketing Messages
+  mautic: Mautic
   page: Landing Page
   pages: Landing Pages
   point actions: Point Actions
   point triggers: Point Triggers
   points: Points
+  group: Group
+  groups: Groups
   plugin: Plugin
   plugins: Plugins
   report: Report

.github/styles/vocab.txt → .github/styles/Vocab/Mautic/accept.txt

@@ -1,5 +1,9 @@
 AJAX
 allowlist
+Amazon SES
+Ameling
+Autoloader
+autoloader
 Autowired
 autowired
 bcc
@@ -10,6 +14,7 @@ blocklist
 boolean
 booleans
 cc
+CCPA
 Citrix
 Clearbit
 CloudAMQP
@@ -19,57 +24,83 @@ Composer
 configurator
 ConnectWise
 Contribution(s)
+CORS
 cron
 Cron
 CTRL
+Custom Fields
+DDEV
+Do Not Contact
+DNC
 Dripflow
+Dynamic Web Content
 FALSE
+Focus Item
+Focus Items
 Froala
 Froogaloop
 gcm
+GIF
 GitBook
 GitHub
+Gitpod
 GMail
 Grav
 Gravatar
+Hammerschmied
 href
 HTML
 http
 https
 HubSpot
+IDP
+IMAP
 infographics
 JavaScript
 Joomla
+Joomla!
 Libre
 Licensor
 LinkedIn
 Mailjet
+Marketing Messages
 Mautic
+MaxMind
 Middlewares
 middlewares
 MJML
 Multiselect
 multiselect
+MVP
 mysqldump
 namespace
 Namespace
 noindex
 OAuth
 Packagist
 PATCH
+patch
 PHP
 Pipedrive
 Piwik
 POST
+post
 PUT
 Rackspace
 Remarketing
 Salesforce
+SAML
 Schimpf
-scp
+SCP
 SendGrid
+SES
+shortcode
+shortcodes
 SMS
+SMTP
+SNS
 SparkPost
+SSO
 sublicense
 SugarCRM
 Suhosin
@@ -83,7 +114,7 @@ unpublish
 Unpublish
 URL
 URLs
-utm
+UTM
 Vtiger
 Webmecanik
 www

.github/workflows/linting.yml

@@ -1,35 +1,31 @@
 name: Linting
 on:
-  # Note: onlyAnnotateModifiedLines only works correctly on PRs!
-  # If you need to run checks on push as well, create a separate workflow file.
   pull_request:
 
 jobs:
   prose:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Vale
-      uses: errata-ai/vale-action@master
+      uses: errata-ai/vale-action@reviewdog
       with:
-        # We can modify these styles as we want
-        styles: |
-          https://github.com/errata-ai/Google/releases/latest/download/Google.zip
-        onlyAnnotateModifiedLines: true
+        # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
+        version: 2.29.2
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   build:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v4
       with:
         python-version: '3.x'
         cache: 'pip'

.gitignore

@@ -72,7 +72,6 @@ cover/
 
 # Translations
 *.mo
-*.pot
 
 # Django stuff:
 *.log

.gitpod.Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.10
+
+# 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
+
+WORKDIR /workspace
+
+# Needed for Vale (rst2html) and reStructuredText (rstcheck)
+RUN pip install rst2html rstcheck
+
+RUN mkdir -p vale && cd vale && wget https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz && \
+    tar -xf vale_${VALE_VERSION}_Linux_64-bit.tar.gz && cp /workspace/vale/vale /usr/local/bin/vale && cd ../
+
+# /home/gitpod/.local/bin ensures that Python packages like rstcheck can be found
+ENV PATH=/home/gitpod/.local/bin:$PATH
+
+# Create the gitpod user. UID must be 33333. https://www.gitpod.io/docs/configure/workspaces/workspace-image#use-a-custom-dockerfile
+RUN useradd -l -u 33333 -G sudo -md /home/gitpod -s /bin/bash -p gitpod gitpod
+
+USER gitpod

.gitpod.yml

@@ -12,23 +12,4 @@ vscode:
     - lextudio.restructuredtext
     - trond-snekvik.simple-rst
     - errata-ai.vale-server
-    - eamodio.gitlens
-
-github:
-  prebuilds:
-    # enable for the master/default branch (defaults to true)
-    master: true
-    # enable for all branches in this repo (defaults to false)
-    branches: true
-    # enable for pull requests coming from this repo (defaults to true)
-    pullRequests: true
-    # enable for pull requests coming from forks (defaults to false)
-    pullRequestsFromForks: true
-    # add a check to pull requests (defaults to true)
-    addCheck: false
-    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
-    addComment: false
-    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
-    addBadge: true
-    # add a label once the prebuild is ready to pull requests (defaults to false)
-    addLabel: false
+    - eamodio.gitlens

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

.vale.ini

@@ -1,4 +1,5 @@
 StylesPath = .github/styles
+Vocab = Mautic
 MinAlertLevel = suggestion
 [*.{md,rst}]
 BasedOnStyles = Vale, Google, Mautic

.vscode/settings.json

@@ -4,5 +4,6 @@
     "vale.valeCLI.path": "/sphinx-tools/vale/vale",
     "esbonio.sphinx.buildDir": "${workspaceFolder}/build",
     "esbonio.sphinx.confDir": "${workspaceFolder}/docs",
-    "restructuredtext.pythonRecommendation.disabled": true
-}
+    "restructuredtext.pythonRecommendation.disabled": true,
+    "restructuredtext.preview.name": "sphinx"
+}

.vscode/welcome.md

@@ -1,9 +1,9 @@
-Welcome to the Mautic end user documentation editor!
+Welcome to the Mautic End User documentation editor., open
 
-We've already set up everything you need. To get started, follow these steps:
-1. Open a file in the `docs/` folder (files that end with `.rst` are docs files)
-2. Click the magnifier icon in the top right corner to see a LIVE preview of the file you're editing
+Everything you need is already set up. To get started, follow these steps:
+1. Open a file in the `docs/` folder - files that end with `.rst` are docs files.
+2. Click the magnifier icon in the top right corner to see a live preview of the file you're editing.
 
 Pretty cool, right?
 
-Happy writing!
+Happy writing.