Skip to content

Commit 31e3535

Browse files
authored
Merge branch 'master' into install-docs-updates
2 parents ddff5a0 + 1867052 commit 31e3535

14 files changed

+554
-510
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,4 @@ source/developer/localization.md
6969
# Generated PKI files
7070
*.key
7171
*.crt
72+
.aider*

fix_config_settings.py

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
import re
2+
import sys
3+
from pathlib import Path
4+
5+
if len(sys.argv) != 2:
6+
print("Usage: python fix_config_settings.py <rst_file_path>")
7+
sys.exit(1)
8+
9+
def to_slug(text):
10+
# Convert text to lowercase and replace spaces with hyphens
11+
slug = text.lower().replace(' ', '-')
12+
# Remove any characters that aren't alphanumeric or hyphens
13+
slug = re.sub(r'[^a-z0-9-]', '', slug)
14+
# Replace multiple hyphens with single hyphen
15+
slug = re.sub(r'-+', '-', slug)
16+
return slug
17+
18+
def process_file(filepath):
19+
with open(filepath, 'r', encoding='utf-8') as f:
20+
content = f.read()
21+
22+
# Find all config:setting directives and their associated headings
23+
pattern = r'\.\.[\s]*config:setting::[\s]*([^\n]+)[\s\S]*?(?=^[^\s#].*$\n[-~=]+$)(.*?)\n[-~=]+'
24+
matches = re.finditer(pattern, content, re.MULTILINE)
25+
26+
for match in matches:
27+
directive_value = match.group(1).strip()
28+
heading = match.group(2).strip()
29+
30+
# Convert heading to slug format
31+
heading_slug = to_slug(heading)
32+
33+
if directive_value != heading_slug:
34+
# Replace the directive value with the heading slug
35+
old_directive = f'.. config:setting:: {directive_value}'
36+
new_directive = f'.. config:setting:: {heading_slug}'
37+
content = content.replace(old_directive, new_directive)
38+
39+
# Write the modified content back to the file
40+
with open(filepath, 'w', encoding='utf-8') as f:
41+
f.write(content)
42+
43+
if __name__ == '__main__':
44+
filepath = sys.argv[1]
45+
process_file(filepath)

source/about/mattermost-mobile-releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ We strongly recommend using the latest mobile app release available that contain
2121

2222
| **Release** | **Released on** | **Support ends** | **Compatible with** |
2323
|:---|:---|:---|:---|
24-
| v2.25 {ref}`FEATURE <release-v2-25-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.25.0) \| {ref}`Changelog <release-v2-25-0>` | 2025-02-16 | 2025-03-15 | {ref}`v10.5 <release-v10-5-extended-support-release>`, {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
24+
| v2.25 {ref}`FEATURE <release-v2-25-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.25.0) \| {ref}`Changelog <release-v2-25-0>` | 2025-02-16 | 2025-03-15 | {ref}`v10.5 <release-v10.5-extended-support-release>`, {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
2525
| v2.24 {ref}`FEATURE <release-v2-24-1>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.24.1) \| {ref}`Changelog <release-v2-24-1>` | 2025-01-16 | 2025-02-15 | {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
2626
| v2.23 {ref}`FEATURE <release-v2-23-1>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.23.1) \| {ref}`Changelog <release-v2-23-1>` | 2024-12-16 | 2025-01-15 | {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
2727
| v2.22 {ref}`FEATURE <release-v2-22-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.22.0) \| {ref}`Changelog <release-v2-22-0>` | 2024-11-15 | 2024-12-15 | {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v10.0 <release-v10.0-major-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>`, {ref}`v9.5 <release-v9-5-extended-support-release>` |

source/configure/authentication-configuration-settings.rst

Lines changed: 82 additions & 82 deletions
Large diffs are not rendered by default.

source/configure/compliance-configuration-settings.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Changes to properties in this section require a server restart before taking eff
3535

3636
Access the following configuration settings in the System Console by going to **Compliance > Data Retention Policies**.
3737

38-
.. config:setting:: dataretention-globalmessagepolicy
38+
.. config:setting:: global-retention-policy-for-messages
3939
:displayname: Global retention policy for messages (Data Retention)
4040
:systemconsole: Compliance > Data Retention Policies
4141
:configjson: .DataRetentionSettings.MessageRetentionDays
@@ -61,7 +61,7 @@ By default, messages are kept forever. If **Hours**, **Days**, or **Years** is c
6161

6262
From Mattermost v9.5, when a ``MessageRetentionHours`` value is configured, the ``MessageRetentionDays`` value must be 0 in the ``config.json`` file. Conversely, when a ``MessageRetentionDays`` value is configured, the ``MessageRetentionHours`` value must be ``0``.
6363

64-
.. config:setting:: dataretention-globalfilepolicy
64+
.. config:setting:: global-retention-policy-for-files
6565
:displayname: Global retention policy for files (Data Retention)
6666
:systemconsole: Compliance > Data Retention Policies
6767
:configjson: .DataRetentionSettings.FileRetentionDays
@@ -87,7 +87,7 @@ By default, files are kept forever. If **Hours**, **Days**, or **Years** is chos
8787

8888
From Mattermost v9.5, when a ``FileRetentionHours`` value is configured, the ``FileRetentionDays`` value must be 0 in the ``config.json`` file. Conversely, when a ``FileRetentionDays`` value is configured, the ``FileRetentionHours`` value must be ``0``.
8989

90-
.. config:setting:: dataretention-customretentionpolicy
90+
.. config:setting:: custom-retention-policy
9191
:displayname: Custom retention policy (Data Retention)
9292
:systemconsole: Compliance > Data Retention Policies
9393
:configjson: .DataRetentionSettings.DeletionJobStartTime
@@ -103,7 +103,7 @@ Custom retention policy
103103

104104
Set how long Mattermost keeps messages and files across specific teams and channels by specifying a name for the custom retention policy, setting a duration value in days or years, and specifying the teams and channels that will follow this policy.
105105

106-
.. config:setting:: dataretention-deletiontime
106+
.. config:setting:: data-deletion-time
107107
:displayname: Data deletion time (Data Retention)
108108
:systemconsole: Compliance > Data Retention Policies
109109
:configjson: .DataRetentionSettings.DeletionJobStartTime
@@ -144,7 +144,7 @@ Compliance export
144144

145145
Access the following configuration settings in the System Console by going to **Compliance > Compliance Export**.
146146

147-
.. config:setting:: compliance-exportenable
147+
.. config:setting:: enable-compliance-export
148148
:displayname: Enable compliance export (Compliance Export)
149149
:systemconsole: Compliance > Compliance Export
150150
:configjson: .MessageExportSettings.EnableExport
@@ -166,7 +166,7 @@ Enable compliance export
166166
| This feature's ``config.json`` setting is ``"EnableExport": false`` with options ``true`` and ``false``. |
167167
+----------------------------------------------------------------------------------------------------------+
168168

169-
.. config:setting:: compliance-exporttime
169+
.. config:setting:: compliance-export-time
170170
:displayname: Compliance export time (Compliance Export)
171171
:systemconsole: Compliance > Compliance Export
172172
:configjson: .MessageExportSettings.DailyRunTime
@@ -186,7 +186,7 @@ This setting is based on the local time of the server.
186186
| This feature's ``config.json`` setting is ``"DailyRunTime": 01:00`` with 24-hour timestamp input in the form ``"HH:MM"``. |
187187
+---------------------------------------------------------------------------------------------------------------------------+
188188

189-
.. config:setting:: compliance-exportformat
189+
.. config:setting:: export-file-format
190190
:displayname: Export file format (Compliance Export)
191191
:systemconsole: Compliance > Compliance Export
192192
:configjson: .MessageExportSettings.ExportFormat
@@ -204,7 +204,7 @@ Currently supported formats are CSV, Actiance XML, and Global Relay EML.
204204

205205
If Global Relay is chosen, the following options will be presented:
206206

207-
.. config:setting:: compliance-exportglobalrelaycustomertype
207+
.. config:setting:: global-relay-customer-account
208208
:displayname: Global Relay customer account (Compliance Export - Global Relay EML)
209209
:systemconsole: Compliance > Compliance Export
210210
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomerType
@@ -222,7 +222,7 @@ Type of Global Relay customer account your organization has. Can be one of: ``A9
222222
| This feature's ``config.json`` setting is ``"CustomerType": "A9"`` with options ``"A9``, ``"A10"``, and ``CUSTOM``. |
223223
+---------------------------------------------------------------------------------------------------------------------+
224224

225-
.. config:setting:: compliance-exportglobalrelaysmtpuser
225+
.. config:setting:: global-relay-smtp-username
226226
:displayname: Global Relay SMTP username (Compliance Export - Global Relay EML)
227227
:systemconsole: Compliance > Compliance Export
228228
:configjson: .MessageExportSettings.GlobalRelaySettings.SmtpUsername
@@ -240,7 +240,7 @@ The username for authenticating to the Global Relay SMTP server.
240240
| This feature's ``config.json`` setting is ``"SmtpUsername": ""`` with string input. |
241241
+-------------------------------------------------------------------------------------+
242242

243-
.. config:setting:: compliance-exportglobalrelaysmtppassword
243+
.. config:setting:: global-relay-smtp-password
244244
:displayname: Global Relay SMTP password (Compliance Export - Global Relay EML)
245245
:systemconsole: Compliance > Compliance Export
246246
:configjson: .MessageExportSettings.GlobalRelaySettings.SMTPPassword
@@ -258,7 +258,7 @@ The password associated with the Global Relay SMTP username.
258258
| This feature's ``config.json`` setting is ``"SmtpPassword": ""`` with string input. |
259259
+-------------------------------------------------------------------------------------+
260260

261-
.. config:setting:: compliance-exportglobalrelayemail
261+
.. config:setting:: global-relay-email-address
262262
:displayname: Global Relay email address (Compliance Export - Global Relay EML)
263263
:systemconsole: Compliance > Compliance Export
264264
:configjson: .MessageExportSettings.GlobalRelaySettings.EmailAddress
@@ -276,7 +276,7 @@ The email address your Global Relay server monitors for incoming compliance expo
276276
| This feature's ``config.json`` setting is ``"EmailAddress": ""`` with string input. |
277277
+-------------------------------------------------------------------------------------+
278278

279-
.. config:setting:: compliance-exportglobalrelaysmtpserver
279+
.. config:setting:: smtp-server-name
280280
:displayname: SMTP server name (Compliance Export - Global Relay EML)
281281
:systemconsole: Compliance > Compliance Export
282282
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName
@@ -292,7 +292,7 @@ The SMTP server name URL that will receive your Global Relay EML file when a `cu
292292
| This feature's ``config.json`` setting is ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName": ""`` with string input. |
293293
+----------------------------------------------------------------------------------------------------------------------------------------+
294294

295-
.. config:setting:: compliance-exportglobalrelaysmtpport
295+
.. config:setting:: smtp-server-port
296296
:displayname: SMTP server port (Compliance Export - Global Relay EML)
297297
:systemconsole: Compliance > Compliance Export
298298
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomSMTPPort
@@ -327,7 +327,7 @@ Settings used to enable and configure Mattermost compliance reports.
327327

328328
Access the following configuration settings in the System Console by going to **Compliance > Compliance Monitoring**.
329329

330-
.. config:setting:: compliance-monitorenable
330+
.. config:setting:: enable-compliance-reporting
331331
:displayname: Enable compliance reporting (Compliance Monitoring)
332332
:systemconsole: Compliance > Compliance Monitoring
333333
:configjson: .ComplianceSettings.Enable
@@ -349,7 +349,7 @@ Enable compliance reporting
349349
| This feature's ``config.json`` setting is ``"Enable": false`` with options ``true`` and ``false``. |
350350
+----------------------------------------------------------------------------------------------------+
351351

352-
.. config:setting:: compliance-monitordirectory
352+
.. config:setting:: compliance-report-directory
353353
:displayname: Compliance report directory (Compliance Monitoring)
354354
:systemconsole: Compliance > Compliance Monitoring
355355
:configjson: .ComplianceSettings.Directory
@@ -367,7 +367,7 @@ Sets the directory where compliance reports are written.
367367
| This feature's ``config.json`` setting is ``"Directory": "./data/"`` with string input. |
368368
+-----------------------------------------------------------------------------------------+
369369

370-
.. config:setting:: compliance-monitorenabledaily
370+
.. config:setting:: enable-compliance-reportingdaily
371371
:displayname: Enable daily report (Compliance Monitoring)
372372
:systemconsole: Compliance > Compliance Monitoring
373373
:configjson: .ComplianceSettings.EnableDaily
@@ -389,7 +389,7 @@ Enable daily report
389389
| This feature's ``config.json`` setting is ``"EnableDaily": false`` with options ``true`` and ``false``. |
390390
+---------------------------------------------------------------------------------------------------------+
391391

392-
.. config:setting:: compliance-monitorbatchsize
392+
.. config:setting:: batch-size
393393
:displayname: Batch size (Compliance Monitoring)
394394
:systemconsole: Compliance > Compliance Monitoring
395395
:configjson: .ComplianceSettings.BatchSize
@@ -417,7 +417,7 @@ Custom terms of service
417417

418418
Access the following configuration settings in the System Console by going to **Compliance > Custom Terms of Service**.
419419

420-
.. config:setting:: compliance-ctosenable
420+
.. config:setting:: enable-custom-terms-of-service
421421
:displayname: Enable custom terms of service (Custom Terms of Service)
422422
:systemconsole: Compliance > Custom Terms of Service
423423
:configjson: .SupportSettings.CustomTermsOfServiceEnabled
@@ -438,7 +438,7 @@ Enable custom terms of service
438438

439439
**False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**.
440440

441-
.. config:setting:: compliance-ctostext
441+
.. config:setting:: custom-terms-of-service-text
442442
:displayname: Custom terms of service text (Custom Terms of Service)
443443
:systemconsole: Compliance > Custom Terms of Service
444444
:configjson: N/A
@@ -452,7 +452,7 @@ Custom terms of service text
452452

453453
Text that will appear in your custom Terms of Service. Supports Markdown-formatted text.
454454

455-
.. config:setting:: compliance-ctosreacceptanceperiod
455+
.. config:setting:: re-acceptance-period
456456
:displayname: Re-acceptance period (Custom Terms of Service)
457457
:systemconsole: Compliance > Custom Terms of Service
458458
:configjson: .SupportSettings.CustomTermsOfServiceReAcceptancePeriod

0 commit comments

Comments
 (0)