Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge Main to 4.x #220

Merged
merged 647 commits into from
Jan 9, 2024
Merged
Changes from 4 commits
Commits
Show all changes
647 commits
Select commit Hold shift + click to select a range
0bdbe38
Merge branch 'main' into TEDU-131-add-themes-section
favour-chibueze Feb 20, 2023
f1952d9
resolve suggestions
favour-chibueze Feb 20, 2023
10aad03
Merge branch 'main' into TEDU-129-add-points-section
favour-chibueze Feb 20, 2023
bbc74cd
Merge branch 'main' into TEDU-106-contacts-section
favour-chibueze Feb 20, 2023
03c9ef9
resolve suggestions
favour-chibueze Feb 20, 2023
04e8fef
resolved suggestions
favour-chibueze Feb 20, 2023
889b14c
Vale fixes, update content
RCheesley Feb 22, 2023
0b687d3
Merge pull request #113 from favour-chibueze/TEDU-131-add-themes-section
RCheesley Feb 22, 2023
2f728b3
Merge branch 'main' into TEDU-129-add-points-section
RCheesley Feb 22, 2023
be9b679
Very small change
RCheesley Feb 22, 2023
1dcc958
Merge branch 'TEDU-129-add-points-section' of https://github.com/favo…
RCheesley Feb 22, 2023
4ea668b
Merge pull request #112 from favour-chibueze/TEDU-129-add-points-section
RCheesley Feb 22, 2023
8c79b74
Merge branch 'main' into TEDU-122-add-search-section
RCheesley Feb 22, 2023
5935221
Merge pull request #100 from favour-chibueze/TEDU-122-add-search-section
RCheesley Feb 22, 2023
a932cf0
Merge branch 'main' into TEDU-106-contacts-section
RCheesley Feb 22, 2023
c579ac2
Vale fixes, update screenshots
RCheesley Feb 22, 2023
f7791bf
Merge branch 'main' into TEDU-107-segments-section
RCheesley Feb 22, 2023
9dd7c8c
Multiple Vale fixes
RCheesley Feb 22, 2023
adad1f6
Merge pull request #97 from favour-chibueze/TEDU-107-segments-section
RCheesley Feb 22, 2023
84a1751
Merge branch 'main' into TEDU-106-contacts-section
favour-chibueze Mar 8, 2023
08ea847
added stages
favour-chibueze Mar 15, 2023
bcc6cf1
Merge branch 'main' into TEDU-135-add-stages
favour-chibueze Mar 15, 2023
adadb50
Add updated files for translation
RCheesley Mar 17, 2023
a2c8e57
Apply translations in pt_BR
transifex-integration[bot] Mar 17, 2023
0d78a53
Apply translations in pt_BR
transifex-integration[bot] Mar 17, 2023
acb2e3d
Apply translations in pt_BR
transifex-integration[bot] Mar 17, 2023
1c0abd3
Apply translations in pt_BR
transifex-integration[bot] Mar 17, 2023
8640edb
docs: update README.md [skip ci]
allcontributors[bot] Mar 20, 2023
6b2fee9
docs: create .all-contributorsrc [skip ci]
allcontributors[bot] Mar 20, 2023
fbfdde2
Merge pull request #145 from mautic/all-contributors/add-gustavokennedy
RCheesley Mar 20, 2023
d638f4f
Merge branch 'main' into translations_docs-docs-translations-index-po…
RCheesley Mar 20, 2023
7a785f9
Merge pull request #141 from mautic/translations_docs-docs-translatio…
RCheesley Mar 20, 2023
04b684e
Merge branch 'main' into translations_docs-docs-translations-translat…
RCheesley Mar 20, 2023
273c855
Merge pull request #142 from mautic/translations_docs-docs-translatio…
RCheesley Mar 20, 2023
cb5d2b4
Merge branch 'main' into translations_docs-docs-translations-contacts…
RCheesley Mar 20, 2023
a356ac2
Merge pull request #143 from mautic/translations_docs-docs-translatio…
RCheesley Mar 20, 2023
833173b
Merge branch 'main' into translations_docs-docs-translations-stages-p…
RCheesley Mar 20, 2023
a3c6b90
Apply translations in pt_BR
transifex-integration[bot] Mar 20, 2023
416120a
Apply translations in pt_BR
transifex-integration[bot] Mar 20, 2023
7273f87
Merge pull request #147 from mautic/translations_docs-docs-translatio…
RCheesley Mar 21, 2023
c79d418
Merge branch 'main' into translations_docs-docs-translations-categori…
RCheesley Mar 21, 2023
0555e5c
Merge pull request #146 from mautic/translations_docs-docs-translatio…
RCheesley Mar 21, 2023
bc43d4b
Apply translations in pt_BR
transifex-integration[bot] Mar 22, 2023
003f66a
Apply translations in pt_BR
transifex-integration[bot] Mar 22, 2023
77f5dc3
Apply translations in pt_BR
transifex-integration[bot] Mar 23, 2023
8c77986
Merge pull request #148 from mautic/translations_docs-docs-translatio…
RCheesley Mar 23, 2023
af3f059
Merge branch 'main' into translations_docs-docs-translations-overview…
RCheesley Mar 23, 2023
4b88c20
Merge pull request #150 from mautic/translations_docs-docs-translatio…
RCheesley Mar 23, 2023
88d3397
Merge branch 'main' into translations_docs-docs-translations-dashboar…
RCheesley Mar 23, 2023
252bbba
Merge pull request #149 from mautic/translations_docs-docs-translatio…
RCheesley Mar 23, 2023
8dc5896
Merge branch 'main' into translations_docs-docs-translations-stages-p…
RCheesley Mar 23, 2023
736cec2
Merge pull request #144 from mautic/translations_docs-docs-translatio…
RCheesley Mar 23, 2023
d1faca5
Apply translations in pt_BR
transifex-integration[bot] Mar 23, 2023
7606ac4
feat: [DPMMA-2095] point leagues documentation
patrykgruszka Mar 24, 2023
41bbc8f
feat: [DPMMA-2095] update sidebar
patrykgruszka Mar 24, 2023
c8e1903
Apply translations in pt_BR
transifex-integration[bot] Mar 24, 2023
0ebcbf5
Merge pull request #153 from mautic/translations_docs-docs-translatio…
RCheesley Mar 24, 2023
15ad346
Merge branch 'main' into translations_docs-docs-translations-search-p…
RCheesley Mar 24, 2023
39fd746
Merge pull request #151 from mautic/translations_docs-docs-translatio…
RCheesley Mar 24, 2023
8ff47f5
feat: [DPMMA-2095] cw correct
patrykgruszka Mar 24, 2023
4671846
Apply translations in ru
transifex-integration[bot] Mar 28, 2023
a52b0b5
docs: update README.md [skip ci]
allcontributors[bot] Mar 28, 2023
99db80d
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Mar 28, 2023
bae9c89
Merge pull request #156 from mautic/all-contributors/add-zaharovrd
RCheesley Mar 28, 2023
1d20844
Merge branch 'main' into translations_docs-docs-translations-companie…
RCheesley Mar 28, 2023
353610d
Merge pull request #155 from mautic/translations_docs-docs-translatio…
RCheesley Mar 28, 2023
d8fb0cc
Merge branch 'main' into TEDU-135-add-stages
favour-chibueze Apr 13, 2023
350dcf9
added images
favour-chibueze Apr 13, 2023
c533c97
Merge branch 'main' into TEDU-106-contacts-section
favour-chibueze Apr 13, 2023
7ba047c
replace images
favour-chibueze Apr 13, 2023
29b5d4c
updated image
favour-chibueze Apr 13, 2023
f257581
fixed inconsistent title headings
favour-chibueze Apr 13, 2023
77e7f00
changed duplicated heading
favour-chibueze Apr 13, 2023
ae67204
fix heading inconsistency
favour-chibueze Apr 14, 2023
2e652b9
Apply suggestions from code review
RCheesley May 3, 2023
d006165
[DPMMA-2108] Add UTM to Asset download #12098
tomekkowalczyk May 5, 2023
e9d70aa
Update assets.rst
RCheesley May 5, 2023
19e09f8
Update docs/components/assets.rst
tomekkowalczyk May 8, 2023
8ea9cf5
Change section Create Asset
tomekkowalczyk May 8, 2023
800330b
Translate authentication.pot in es
transifex-integration[bot] May 9, 2023
cadd598
Merge pull request #160 from mautic/translations_docs-docs-translatio…
RCheesley May 9, 2023
4fdf329
Fix issues with duplicate headings
RCheesley May 16, 2023
85199dc
Small tweak to category explanation and weights.
RCheesley May 16, 2023
3b0b8b8
Merge branch 'main' into TEDU-135-add-stages
RCheesley May 16, 2023
96a6825
Merge pull request #140 from favour-chibueze/TEDU-135-add-stages
RCheesley May 16, 2023
475dc84
Merge branch 'main' into fix-asset-headings
RCheesley May 16, 2023
6bf7a8e
Merge pull request #159 from mautic/fix-asset-headings
RCheesley May 16, 2023
f5301ce
Merge branch 'main' into patch-1
RCheesley May 16, 2023
5b4c907
Merge pull request #157 from tomekkowalczyk/patch-1
RCheesley May 16, 2023
c302ff4
docs: update README.md [skip ci]
allcontributors[bot] May 16, 2023
9d4b263
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] May 16, 2023
eb9d44d
Merge pull request #161 from mautic/all-contributors/add-tomekkowalczyk
RCheesley May 16, 2023
d79a6c7
doc: [DPMMA-2044] Editor custom fonts documentation
annamunk May 25, 2023
b0ceb15
doc: [DPMMA-2044] Vale fixes
annamunk May 25, 2023
910bb11
Translate builders.pot in es
transifex-integration[bot] Jun 3, 2023
3373f13
Translate translations.pot in es
transifex-integration[bot] Jun 3, 2023
1f538e3
Translate docs/docs_translations/stages.pot in es
transifex-integration[bot] Jun 3, 2023
bf626bc
Merge pull request #163 from mautic/translations_docs-docs-translatio…
RCheesley Jun 5, 2023
b189b7f
Merge branch 'main' into translations_docs-docs-translations-translat…
RCheesley Jun 5, 2023
3c820ce
Merge pull request #164 from mautic/translations_docs-docs-translatio…
RCheesley Jun 5, 2023
9ef2e20
Merge branch 'main' into translations_docs-docs-translations-stages-p…
RCheesley Jun 5, 2023
450e33e
Merge pull request #165 from mautic/translations_docs-docs-translatio…
RCheesley Jun 5, 2023
46485d2
docs: update README.md [skip ci]
allcontributors[bot] Jun 6, 2023
95b8d11
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Jun 6, 2023
f2a8f5c
Merge pull request #166 from mautic/all-contributors/add-kukis2107
RCheesley Jun 6, 2023
dcbb5d7
Fix location of translated files
RCheesley Jun 6, 2023
e54db2e
Merge pull request #167 from mautic/fix-translations
RCheesley Jun 6, 2023
a3fe684
Commit missing translations
RCheesley Jun 6, 2023
67a8cf0
Merge pull request #168 from mautic/push-missing-translations
RCheesley Jun 6, 2023
d00abc9
Update README.md
RCheesley Jun 6, 2023
7eb3aa4
Update command_line_interface.rst
Moongazer Jun 7, 2023
85be521
Update command_line_interface.rst
Moongazer Jun 7, 2023
18c1679
Merge pull request #170 from Moongazer/patch-1
RCheesley Jun 7, 2023
9f1d08e
docs: update README.md [skip ci]
allcontributors[bot] Jun 7, 2023
984f5c9
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Jun 7, 2023
521f7c9
Merge pull request #171 from mautic/all-contributors/add-putzwasser
RCheesley Jun 7, 2023
0c58c88
docs: update README.md [skip ci]
allcontributors[bot] Jun 7, 2023
6c6a590
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Jun 7, 2023
0c2a363
Merge pull request #172 from mautic/all-contributors/add-Moongazer
RCheesley Jun 7, 2023
95863f4
Add missing translations
RCheesley Jun 7, 2023
d767d78
Merge pull request #173 from mautic/update-translations
RCheesley Jun 7, 2023
f150594
Merge branch 'main' into DPMMA-2044-custom-fonts
RCheesley Jun 15, 2023
c071594
Merge pull request #162 from annamunk/DPMMA-2044-custom-fonts
RCheesley Jun 15, 2023
6ff0a10
Starting updating email docs for symfony mailer
escopecz Jun 19, 2023
4d7700d
Documenting SMTP configuration
escopecz Jun 19, 2023
9b2a209
Updating mailer webhook (callback) info for M5
escopecz Jun 19, 2023
28cb513
Typo fix
escopecz Jun 19, 2023
3088502
Updating command to send emails in the background
escopecz Jun 19, 2023
062d36f
Apply suggestions from code review
escopecz Jun 20, 2023
5bfa635
Apply suggestions from code review part 2
escopecz Jun 20, 2023
bea2754
Adding warning that Symfony transports can be installed only via Comp…
escopecz Jun 20, 2023
674cfdd
Adding table with DSN parts explained
escopecz Jun 20, 2023
f16323c
Replacing the old email send command with the new one
escopecz Jun 20, 2023
7113831
Typo fixes
escopecz Jun 20, 2023
f0dd285
fix: [DPMMA-2242] rename league to group
patrykgruszka Jun 22, 2023
2432477
Merge branch 'main' into DPMMA-2095_point-leagues
patrykgruszka Jun 22, 2023
720a156
Merge pull request #174 from escopecz/symfony-mailer
RCheesley Jun 22, 2023
385f03c
Merge branch '5.x' into main
RCheesley Jun 26, 2023
1ac2bd8
Merge pull request #175 from mautic/main
RCheesley Jun 26, 2023
136c27b
Add locale definition for translations
RCheesley Jul 6, 2023
6677595
Merge pull request #181 from mautic/fix-translations-locale
RCheesley Jul 6, 2023
442b944
Merge branch '5.x' into DPMMA-2095_point-leagues
patrykgruszka Jul 18, 2023
e94fd65
fix: [DPMMA-2252] group points action and webhook info
patrykgruszka Jul 19, 2023
06457fa
fix: [DPMMA-2252] fix section title
patrykgruszka Jul 19, 2023
9d8f7ce
Update Tx client & re-create translations
RCheesley Jul 21, 2023
2678c19
Merge branch 'main' into fix-transifex
RCheesley Jul 21, 2023
2141479
Remove backup dir, oops!
RCheesley Jul 21, 2023
55f1a37
Merge branch 'fix-transifex' of https://github.com/mautic/user-docume…
RCheesley Jul 21, 2023
a77d72d
Merge pull request #185 from mautic/fix-transifex
RCheesley Jul 21, 2023
c3fadcf
[skip CI] Translate authentication.pot in pt_BR
transifex-integration[bot] Jul 21, 2023
a72b370
Merge pull request #186 from mautic/translations_beba6d19bc494f1f9c9b…
RCheesley Jul 21, 2023
ad9f6fd
[skip CI] Translate categories.pot in pt_BR
transifex-integration[bot] Jul 21, 2023
b34a14d
Merge pull request #187 from mautic/translations_beba6d19bc494f1f9c9b…
RCheesley Jul 21, 2023
0119d85
Merge branch 'main' into TEDU-106-contacts-section
RCheesley Jul 27, 2023
6e635cc
Merge pull request #152 from patrykgruszka/DPMMA-2095_point-leagues
RCheesley Jul 27, 2023
60b0ba5
Vale fix
RCheesley Jul 27, 2023
27ce59c
Merge branch 'main' into Update-readme
RCheesley Jul 27, 2023
61a3bb7
Merge pull request #169 from mautic/Update-readme
RCheesley Jul 27, 2023
15c6034
Update README.md
RCheesley Jul 27, 2023
4ee944e
docs: update README.md [skip ci]
allcontributors[bot] Jul 27, 2023
bdf8533
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Jul 27, 2023
3e210a8
Merge pull request #188 from mautic/all-contributors/add-patrykgruszka
RCheesley Jul 27, 2023
96adfdf
email_transport queue is now called just email
escopecz Aug 4, 2023
71c9a97
Merge pull request #194 from escopecz/email_transport-to-email
RCheesley Aug 4, 2023
ab2949d
add step for MyST Parser
roboparker Jul 11, 2023
b97da77
Add locale definition for translations
RCheesley Jul 6, 2023
2cea243
add custom fields to chron docs
roboparker Jul 11, 2023
bbfd13b
Update docs/configuration/cron_jobs.rst
roboparker Aug 8, 2023
9bad1c3
Update docs/configuration/cron_jobs.rst
roboparker Aug 8, 2023
0f75b52
Move email settings to config section
RCheesley Jun 27, 2023
c7b70cf
Move to top and rename to transport
RCheesley Jun 27, 2023
79f4ba7
Fix leftover from rebase :blush:
RCheesley Aug 8, 2023
7106ba9
Remove section that was moved to config
RCheesley Aug 8, 2023
dea0873
Vale fixes 🙇🏻‍♀️
RCheesley Aug 8, 2023
d7dc5ad
Missed one 👀🫣
RCheesley Aug 8, 2023
ea326d2
Merge pull request #177 from mautic/refactor-email-dsn-info
RCheesley Aug 8, 2023
12bcfe8
Merge branch '5.x' into custom-fields-chron
RCheesley Aug 8, 2023
d9e5d79
Merge pull request #183 from diaboloshogunate/custom-fields-chron
RCheesley Aug 8, 2023
8bc0402
Update docs/contacts/import_contacts.rst
RCheesley Aug 8, 2023
d96ef73
Merge branch 'main' into TEDU-106-contacts-section
RCheesley Aug 8, 2023
1972710
Apply suggestions from code review
RCheesley Aug 8, 2023
408058a
Apply suggestions from code review
RCheesley Aug 9, 2023
141cc5a
Apply suggestions from code review - contacts_overview.rst
RCheesley Aug 9, 2023
f3369bd
Apply suggestions from code review - custom_fields.rst
RCheesley Aug 9, 2023
e377736
Apply suggestions from code review - frequency_rules.rst
RCheesley Aug 9, 2023
2733a64
Apply suggestions from code review - import_contacts.rst
RCheesley Aug 9, 2023
2d0025c
Apply suggestions from code review
RCheesley Aug 9, 2023
d8505c7
Apply suggestions from code review - preference_center.rst
RCheesley Aug 9, 2023
325f6c8
Apply suggestions from code review
RCheesley Aug 9, 2023
e569923
Apply suggestions from code review - manage_contacts.rst
RCheesley Aug 9, 2023
3db8c1e
Update docs/contacts/manage_contacts.rst
RCheesley Aug 9, 2023
bca7de2
Apply suggestions from code review
RCheesley Aug 9, 2023
1fda913
Update docs/contacts/contacts_overview.rst
RCheesley Aug 9, 2023
2502dbc
Update docs/contacts/contacts_overview.rst
RCheesley Aug 9, 2023
88de771
Apply suggestions from code review
RCheesley Aug 9, 2023
11b5816
Remove import section, link to file
RCheesley Aug 9, 2023
ca77260
Vale fix
RCheesley Aug 9, 2023
264a798
Update docs/contacts/manage_contacts.rst
RCheesley Aug 10, 2023
59cd69c
Fix missing header breaking build
RCheesley Aug 10, 2023
4179bc3
Merge branch 'TEDU-106-contacts-section' of https://github.com/favour…
RCheesley Aug 10, 2023
6afb1ef
Fix uncommented link fragment
RCheesley Aug 10, 2023
4b08b69
Merge pull request #98 from favour-chibueze/TEDU-106-contacts-section
RCheesley Aug 10, 2023
d8782ef
Update authentication.rst
Amiyah14 Aug 28, 2023
c3e37d5
docs: update README.md [skip ci]
allcontributors[bot] Aug 28, 2023
ac3a004
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Aug 28, 2023
2e71e41
Merge pull request #198 from mautic/all-contributors/add-Amiyah14
RCheesley Aug 28, 2023
bbb7d0d
Merge branch 'main' into patch-1
Amiyah14 Sep 5, 2023
e99b557
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
ab66ca8
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
ee221f7
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
1b98dc5
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
e7096bc
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
7e35ace
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
fce16c4
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
dd315f3
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
55f81b7
Update docs/authentication/authentication.rst
Amiyah14 Sep 5, 2023
25c7fbc
Merge pull request #197 from Amiyah14/patch-1
RCheesley Sep 21, 2023
39e2503
Add information on the branch to fork
fakela Oct 9, 2023
472ef3f
Update README.md
fakela Oct 13, 2023
64ab5d0
Update README.md
fakela Oct 13, 2023
633bd62
Merge pull request #201 from mautic/fakela-patch-1
RCheesley Oct 13, 2023
f82da48
fix warning with table syntax
RCheesley Oct 13, 2023
bd76019
fix exclamation points
RCheesley Oct 13, 2023
3f94772
Fix tense
RCheesley Oct 13, 2023
45dd090
Vale fixes
RCheesley Oct 13, 2023
f7898b1
Marketplace link fix
RCheesley Oct 13, 2023
7c3fe1e
Add reviewdog support
RCheesley Oct 13, 2023
d5f0550
Create .gitpod.Dockerfile
RCheesley Oct 13, 2023
28f19d8
Merge pull request #205 from mautic/#203-reviewdog-support
RCheesley Oct 13, 2023
277ab24
Update linting.yml
RCheesley Oct 27, 2023
a7a1651
Update linting.yml
RCheesley Oct 30, 2023
951afe8
Update .gitpod.Dockerfile
RCheesley Oct 30, 2023
d8b7826
Merge pull request #206 from mautic/fix-vale-action
RCheesley Oct 31, 2023
10c0d02
Merge branch 'main' into fix-vale-errors
RCheesley Oct 31, 2023
08b7336
Merge pull request #204 from mautic/fix-vale-errors
RCheesley Nov 15, 2023
a815ccf
Merge branch 'main' into pip-install-myst_parser
RCheesley Nov 21, 2023
6c98060
Merge pull request #182 from diaboloshogunate/pip-install-myst_parser
RCheesley Nov 21, 2023
acffe47
Resolve conflicts
RCheesley Nov 21, 2023
9b502f5
Fix incorrect command
RCheesley Nov 21, 2023
03b6e9b
Add missing quotes
RCheesley Nov 21, 2023
464b705
Resolve conflicts
RCheesley Nov 21, 2023
17f5c5c
Remove language files
RCheesley Nov 21, 2023
9e4edfd
Merge pull request #211 from RCheesley/remove-language-files
RCheesley Nov 21, 2023
d6799a8
remove translation files
RCheesley Nov 21, 2023
8bdde37
Merge pull request #213 from RCheesley/remove-translations-5.x
RCheesley Nov 21, 2023
4890e08
Merge remote-tracking branch 'upstream/main' into main-2-5
escopecz Nov 22, 2023
3e7b96a
Merge pull request #215 from escopecz/main-2-5
RCheesley Dec 22, 2023
714d635
Remove deprecated prebuilds for gitpod
RCheesley Dec 22, 2023
94c03e4
File had a space after file extension! :facepalm:
RCheesley Dec 24, 2023
24f8aae
Merge pull request #219 from mautic/fix-build-fail
RCheesley Dec 24, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -17,6 +17,37 @@ We aim to move all aspects of the end-user documentation to Read the Docs.

For more background, our end goal, and to let us know if you want to help, please join the Education Team channel (#t-education) on Slack (get an invite at https://mautic.org/slack). Thanks in advance!

## Making a PR

To make a small change to the base language files for the documentation, use the 'edit file' button on the documentation and commit your changes. This creates a new Pull Request.

To make more complex changes you need to clone this repository and work on your local computer.

1. Install a code editor, [Visual Studio Code](https://code.visualstudio.com) is recommended as it automatically installs all the extensions you need.
2. Install [Github CLI](https://cli.github.com/) which makes it much easier to work with Git commands
3. Install the dependencies from the requirements.txt file in the root of the /docs folder using the command `pip3 install -r requirements.txt`
4. Create a working folder on your local computer
5. Open a terminal and navigate to that folder using the command `cd <path/to/folder>`
6. Type `gh repo clone mautic/user-documentation` - you may be prompted to authenticate with GitHub the first time you do this
7. Open the folder user-documentation that is created in your editor
8. At the bottom left of your screen you will see the default branch called 'main' is showing as your active branch. Click this, and at the top of the page will show a box where you can select 'create a new branch'. Type a name which relates to the work you plan to do. Once you do this, the bottom left will change from 'main' to the name of the branch you created. At any time you can click back into that, and change back to 'main'.
9. Now you are working on your own branch for this change, make the changes that you need to make by editing the files, which you should see on the left pane.
10. Use the Source Control icon on the menu on the left, to view the files you have changed. Click the plus icon next to them to 'stage' them for committing. This allows you to save files in chunks, explaining what you're doing with each chunk, rather than en-mass. It makes it easier to reverse small parts in the future.
11. If you're making any changes to text, remember to run the commands below to update the files for translations on Transifex and include those in your PR.
12. Once you've committed all your changes, click the Publish Branch button. This might prompt you to create a fork of the repository - that's fine.
13. Once you've published the branch, look for the Branches section in the accordion menu under the Source Control icon. Find your branch and hover over the icon which says 'Create pull request' and click it.
14. This will take you to the web interface of GitHub, where you can give an appropriate title and description for the changes you are proposing.
15. If you need to make changes in the future after review, switch back to this branch as mentioned in step 8. Make the changes, and then follow steps 9-12. Update the pull request when you have completed your changes and committed and pushed them, to ask the reviewer to re-review after the updates.

### Generating translations files

Currently, we manually create the translation files necessary for Transifex to inform translators that there are changes to the content.

To do this, run the following at the command line after following the steps below to build the documentation locally.

1. Run the command in the /docs folder `sphinx-build -b gettext . docs_translations`
2. Commit the files created with your pull request

## Build documentation locally

- [RST Syntax Cheatsheet][RST Cheatsheet]
@@ -78,4 +109,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!