Skip to content

Commit 9ec8ee9

Browse files
RCheesleyRCheesley
authored
Merge branch '5.x' into docs-labelling
2 parents a342591 + 52ca403 commit 9ec8ee9

29 files changed

+1015
-121
lines changed

‎.all-contributorsrc‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,33 @@
3232
"doc",
3333
"review"
3434
]
35+
},
36+
{
37+
"login": "ifeoluwafavour",
38+
"name": "Ife",
39+
"avatar_url": "https://avatars.githubusercontent.com/u/64481442?v=4",
40+
"profile": "http://ifeoluwafavour.hashnode.dev",
41+
"contributions": [
42+
"doc"
43+
]
44+
},
45+
{
46+
"login": "sumbria",
47+
"name": "Balbinder Sumbria",
48+
"avatar_url": "https://avatars.githubusercontent.com/u/6416992?v=4",
49+
"profile": "https://incodit.com",
50+
"contributions": [
51+
"doc"
52+
]
53+
},
54+
{
55+
"login": "Hugo-Prossaird",
56+
"name": "Hugo-Prossaird",
57+
"avatar_url": "https://avatars.githubusercontent.com/u/176997845?v=4",
58+
"profile": "https://github.com/Hugo-Prossaird",
59+
"contributions": [
60+
"doc"
61+
]
3562
}
3663
],
3764
"contributorsPerLine": 7,
@@ -40,5 +67,6 @@
4067
"repoType": "github",
4168
"repoHost": "https://github.com",
4269
"skipCi": true,
43-
"commitConvention": "angular"
70+
"commitConvention": "angular",
71+
"commitType": "docs"
4472
}

‎.github/holopin.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
organization: mautic
2+
holobytes:
3+
- evolvingStickerId: cm1ti4x4c57560cjq2styaitm
4+
icon: avocado
5+
alias: hacktoberfest-2024

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ CloudAMQP
2525
Codeception
2626
Codecov
2727
Company(ies)
28+
Composability
2829
Composer
2930
Config
3031
config
@@ -48,6 +49,8 @@ Firewalls
4849
firewalls
4950
Focus Item
5051
Focus Items
52+
Form
53+
form
5154
Forms
5255
forms
5356
Froala

‎.github/workflows/linting.yml‎

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,49 @@ on:
44

55
jobs:
66
prose:
7-
runs-on: ubuntu-latest
7+
runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading
8+
permissions:
9+
contents: read
10+
pull-requests: write
811
steps:
9-
- name: Checkout
10-
uses: actions/checkout@v4
11-
with:
12-
fetch-depth: 0
13-
14-
- uses: actions/setup-python@v4
15-
with:
16-
python-version: '3.x'
17-
cache: 'pip'
18-
19-
- name: Install Python dependencies
20-
run: pip3 install -r docs/requirements.txt
21-
22-
- name: Vale
23-
uses: errata-ai/vale-action@reviewdog
24-
with:
25-
# Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
26-
version: 2.29.2
27-
fail_on_error: true
28-
env:
29-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- uses: actions/setup-python@v4
18+
with:
19+
python-version: '3.x'
20+
cache: 'pip'
21+
22+
- name: Install Python dependencies
23+
run: pip3 install -r docs/requirements.txt
24+
25+
- name: Vale
26+
uses: errata-ai/vale-action@reviewdog
27+
with:
28+
version: 3.7.1 # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
29+
env:
30+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3031

3132
build:
3233
runs-on: ubuntu-latest
3334
steps:
34-
- name: Checkout
35-
uses: actions/checkout@v4
36-
37-
- uses: actions/setup-python@v4
38-
with:
39-
python-version: '3.x'
40-
cache: 'pip'
41-
42-
- name: Install Python dependencies
43-
run: pip3 install -r docs/requirements.txt
44-
45-
- name: Build docs
46-
working-directory: docs
47-
run: make html
48-
49-
- name: Check links
50-
working-directory: docs
51-
run: make checklinks
35+
- name: Checkout
36+
uses: actions/checkout@v4
37+
38+
- uses: actions/setup-python@v4
39+
with:
40+
python-version: '3.x'
41+
cache: 'pip'
42+
43+
- name: Install Python dependencies
44+
run: pip3 install -r docs/requirements.txt
45+
46+
- name: Build docs
47+
working-directory: docs
48+
run: make html
49+
50+
- name: Check links
51+
working-directory: docs
52+
run: make checklinks

‎.gitpod.Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ FROM python:3.11
22

33
# Don't update to a higher version until this issue has been fixed: https://github.com/errata-ai/vale/issues/528
44
# Please keep version in sync with the version in .github/workflows/linting.yml for a consistent experience
5-
ENV VALE_VERSION=2.29.2
5+
ENV VALE_VERSION=3.7.1
66

77
WORKDIR /workspace
88

‎.gitpod.yml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily
2-
# use this once which has Python 3.9 and Vale preinstalled.
3-
image: dennisameling/python-vale:latest
1+
image:
2+
file: .gitpod.Dockerfile
43

54
tasks:
65
- before: pip install -r docs/requirements.txt
@@ -9,7 +8,9 @@ tasks:
98
vscode:
109
extensions:
1110
- ms-python.python
12-
- lextudio.restructuredtext
13-
- errata-ai.vale-server
11+
- [email protected] # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading. - errata-ai.vale-server
1412
- eamodio.gitlens
1513
- trond-snekvik.simple-rst
14+
15+
ports:
16+
- port: 3000

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
"esbonio.sphinx.confDir": "${workspaceFolder}/docs",
66
"restructuredtext.pythonRecommendation.disabled": true,
77
"restructuredtext.preview.name": "sphinx",
8+
"esbonio.sphinx.pythonCommand": "python3",
9+
"esbonio.sphinx.buildCommand": "sphinx-build",
10+
"esbonio.logging.level": "debug",
811
"gitlens.showWhatsNewAfterUpgrades": false
912
}

‎.well-known/funding-manifest-urls‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/mautic/mautic/blob/5.x/funding.json

‎README.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Documentation Status][RTD badge URL]][RTD URL]
22
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3-
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
55

66
[![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
120120
<table>
121121
<tbody>
122122
<tr>
123-
<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>
124-
<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>
125-
<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>
123+
<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>
124+
<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>
125+
<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>
126+
<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>
127+
<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>
128+
<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>
126129
</tr>
127130
</tbody>
128131
</table>

‎docs/components/cache.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ All you need to do now is to clear all tagged items:
4343
.. code-block:: php
4444
4545
$cache->invalidateTags(['firstTag']);
46+
4647
Pools clearing
4748
==============
4849

@@ -54,6 +55,7 @@ Cache Pools include methods to delete a cache item, some of them, or all of them
5455
.. code-block:: php
5556
5657
$isDeleted = $cache->deleteItem('user_'.$userId);
58+
5759
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.
5860

5961
Configuration
@@ -68,6 +70,7 @@ These are the default settings:
6870
'cache_adapter' => 'mautic.cache.adapter.filesystem',
6971
'cache_prefix' => 'app',
7072
'cache_lifetime' => 86400
73+
7174
They can be overridden in ``local.php`` like this:
7275

7376
.. code-block:: php
@@ -84,6 +87,7 @@ Delivered adapters
8487
- ``mautic.cache.adapter.memcached``
8588

8689
.. code-block:: php
90+
8791
'memcached' => [
8892
'servers' => ['memcached://localhost'],
8993
'options' => [

0 commit comments

Comments
 (0)