docs/plugins/images/alphanumeric-id.png - this image needs updating as the buttons are the wrong way round.

Originally posted by @RCheesley in #71 (review)

Twilio also introduced some major changes which are released with Mautic 5 (see mautic/mautic#12539) and we need to better guide people through this process/workflow.

Review installing from production package page and move to the new doc
https://docs.mautic.org/en/setup/how-to-install-mautic/install-mautic-from-package

• add screenshots where necessary
• proofread the documentation
• make changes where necessary
• add additional information that would be useful

https://docs.mautic.org/en/campaigns

I don't know if this is meant to be in the end-user docs or if we moved it to the developer docs or the community handbook > tester section?

https://github.com/mautic/mautic-documentation/blob/main/pages/15.Plugins/00.General%20Resources/01.Integration%20test/docs.en.md

This is a much-requested documentation resource and is very important seeing as we are going to be encouraging more to use Composer.

https://docs.mautic.org/en/components/dynamic-web-content

@fakela
The current How to Update page has a section on "What to do if you need help updating Mautic?". This section is repeated several times across different pages. We can add a section in the user guide as Resources and FAQ. As needed, writers can point the readers to this section for reference.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Add the documentation on how to contribute to mautic

• add screenshot where necessary
• proofread the documentation
• make changes where necessary
• add additional information that would be useful

From the old documentation https://docs.mautic.org/en/contributing

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Google changed the way it allows sign-ins to 3rd party apps. Unfortunately, this means that I can't set up my SMTP because I can't sign into my Google account (through which my business email runs). Is there a way of changing it so that there's an ability to sign in via Google, instead of having to input usernames and passwords?

This needs to be in our end-user docs and also at mautic.org/download/requirements - we now require NPM because it's used for building JS dependencies but people are coming up against problems because it's not clearly documented.

Forum threads:

https://forum.mautic.org/t/unable-to-install-mautic-5-0-2-with-composer/30670

https://forum.mautic.org/t/composer-setup-for-mautic-5-now-needs-npm/29823

https://forum.mautic.org/t/mautictwigtemplatesbundle-not-shown/30595/6

1. Perhaps we can document the specific extensions needed for installing Mautic (@jos0405 do you have this documented already somewhere?)
2. We should include this in the composer docs updates, also.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

According to the blog post here: https://blog.readthedocs.com/use-build-os-config/ and the docs here: https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os we need to switch to using build.os.

Small change needed, see https://blog.readthedocs.com/use-build-os-config/ for the details.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

We seem to be missing this section:

https://github.com/mautic/mautic-documentation/blob/main/pages/11.Components/03.Forms/02.Progressive%20Profiling/docs.en.md

Note: URL for redirecting: https://docs.mautic.org/en/components/forms/progressive-profiling

https://docs.mautic.org/en/authentication

Review the Getting started page and move to the new docs
https://docs.mautic.org/en/setup/how-to-install-mautic

• add screenshots where necessary

• proofread the documentation

• make changes where necessary

• add additional information that would be useful

See this PR: mautic/mautic#11351

When the publish-up date for a segment email is in the past, the email should be getting sent, so the send button will be greyed out to prevent the duplication of email sends.

⚠️ As the PR is on the 5.x branch, this will only apply to the Mautic 5 release, so we will need to make this change on the 5.0 branch of the docs.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

In this PR mautic/developer-documentation-new#87 on the dev docs we updated the Vale version and now Reviewdog allows in-line feedback and also allows it to work on PRs from forks which is much more helpful for our contributors.

We should bring this over to the end-user docs as well! Currently they are output in a very unfriendly command line list in the actions logs.

Should hopefully be a case of copying what has been done in the dev docs and making a PR on the end user docs here: mautic/user-documentation .

We don't currently have any section in the docs which walks through all the settings in the configuration menu. I think we should add this, but it will be a big PR and take quite a lot of work to actually determine what each setting does in a way we can explain to users.

I do think it would be a very valuable resource, however.

I am pre-emptively using a link to

:ref:`CORS Settings`

in one of the docs I am writing, because I don't think that we should be including configuration information in individual pages. Instead we should link to the relevant part of the configuration docs.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

https://docs.mautic.org/en/setup/how-to-update-mautic

Add the documentation on ways a contributor can contribute to Mautic

• add screenshots where necessary

• proofread the documentation

• make changes where necessary

• add additional information that would be useful

From the old documentation https://docs.mautic.org/en/contributing/style-guide

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Not sure how, but the tracking script instructions seem to have been added on the cron jobs page which seems a bit counterintuitive.

https://docs.mautic/org/en/5.x/configuration/cron_jobs.html#tracking-script

I think this should be under the installing Mautic section, perhaps?

NOTE: Update redirect when this is done.

@RCheesley I tried to run gitpod and preview the pages. i had these errors

Originally posted by @fakela in #9 (comment)

With the error:

Cloning into 'C:\xxx\www\user-documentation'...
remote: Enumerating objects: 9244, done.        
remote: Counting objects: 100% (1037/1037), done.        
remote: Compressing objects: 100% (457/457), done.        
remote: Total 9244 (delta 568), reused 931 (delta 513), pack-reused 8207        
Receiving objects: 100% (9244/9244), 20.44 MiB | 24.31 MiB/s, done.
Resolving deltas: 100% (5673/5673), done.
error: invalid path '.readthedocs.yaml '
fatal: unable to checkout working tree
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

Here's how you can try to solve it:

Manual renaming
Go to the repository on your GitHub (or wherever it's hosted), find the offending file and rename it (remove the space in your case).
Then clone the repository again.

We removed the general troubleshooting section, but this page still refers to it:

https://docs.mautic.org/en/5.x/getting_started/how_to_update_mautic.html#the-update-wasn-t-successful

This should be updated (and maybe we need to point them to the forum? Or maybe we need a troubleshooting section? Open to thoughts!)

This could be replaced with a link to the Composer installation

Originally posted by @escopecz in #235 (comment)

https://docs.mautic.org/en/components/assets

I was following the instructions in this topic to update from mautic 5.0.2 to 5.0.3.

I'm using a composer based installation.

https://docs.mautic.org/en/5.x/getting_started/how_to_update_mautic.html

When running the commands under step 5 of Updating Mautic (composer based installs, I ran into the following issues:

1. Running the second command bin/console mautic:update:apply --finish gives an error "You have composer updates enabled. This means that you can only update Mautic through the 'composer update' command." Should this line be removed then from the documentation?

2. Running bin/console doctrine:schema:update --no-interaction --force I received errors:

   Updating database schema...
   
   In ExceptionConverter.php line 117:
   
   An exception occurred while executing a query: SQLSTATE[42000]: Syntax error or access violation: 1091 Can't DROP 'IDX_1AE3441319EB6921'; check that column/key exists
   
   In Exception.php line 28:
   
   SQLSTATE[42000]: Syntax error or access violation: 1091 Can't DROP 'IDX_1AE3441319EB6921'; check that column/key exists
   
   In Connection.php line 33:
   
   SQLSTATE[42000]: Syntax error or access violation: 1091 Can't DROP 'IDX_1AE3441319EB6921'; check that column/key exists
   

   I'm not sure if those are valid errors, or just because the migrations already applied them in the previous step. In most migration technologies I've used in the past you can make schema and data updates apply in one command. I'm sorry I'm not familiar with doctrine migrations.

From the old documentation https://docs.mautic.org/en/overview-of-mautic we have the overview page

This needs to be moved to the new documentation. It should be proofreaded and changes should be made where necessary.

I am assuming

composer create-project mautic/recommended-project:^4 some-dir --no-interaction

Should be

composer create-project mautic/recommended-project:^5 some-dir --no-interaction

URL: https://docs.mautic.org/en/5.x/getting_started/how_to_install_mautic.html#installing-with-composer

In Mautic 5 we are fundamentally changing the way in which transactional emails work. See mautic/mautic#11786 for the background.

Current behaviour:

If a user has DNC set for the email channel, they will NOT receive any transactional emails. This is a problem as transactional emails relate to things which the user should be notified about even if they have opted out of emails - for example password reset, order updates etc.

New behaviour:

From Mautic 5, transactional emails will IGNORE the DNC setting and always be sent to the user.

This means we need to update the end-user documentation to make this abundantly clear.

⚠️ BE SURE TO MAKE THE UPDATE ON THE 5.x BRANCH OF THIS REPO SO THAT IT ONLY APPLIES TO THE 5.x VERSION! ⚠️

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

This used to be on the docs, but maybe it sits better in the Community handbook (contribute.mautic.org)?

Either way, we should have it loud and proud on the landing page, how to contribute!

Note for redirects:

https://docs.mautic.org/en/contributing/style-guide
https://docs.mautic.org/en/contributing

https://docs.mautic.org/en/5.x/translations/translations.html is blank - content is here: https://github.com/mautic/mautic-documentation/tree/main/pages/22.Translations

https://docs.mautic.org/en/setup/how-to-update-mautic/updating-in-the-browser

See mautic/mautic#12696 - please make the PR on the 5.x branch!

The screenshot here: https://docs.mautic.org/en/5.x/configuration/settings.html#mail-send-settings is using the old Mautic 4 settings. We should update it so it's showing the layout which comes with Mautic 5.

https://docs.mautic.org/en/components/landing-pages

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

https://docs.mautic.org/en/setup/how-to-update-mautic/updating-at-command-line

https://docs.mautic.org/en/5.x/components/forms.html?highlight=UTM#form-actions has content about forms using UTM tags but we don't mention it on https://docs.mautic.org/en/5.x/channels/utm_tags.html - would be good to add it there and link to it from the form actions section.

• Managing forms
• Progressive profiling
• Recording UTM tags
• Conditional fields

I think these will all be in one page, using heading to navigate the sections.

https://docs.mautic.org/en/5.x/themes/theme_structure.html is missing content.

https://github.com/mautic/mautic-documentation/blob/main/pages/21.Themes/03.Theme%20structure/docs.en.md

NOTE: link to https://devdocs.mautic.org :)

We don't have the docs any more for the Mautic 3 upgrade steps which some users with very old instances might need.

Here's the docs: https://github.com/mautic/mautic-documentation/tree/main/pages/04.Mautic%203%20upgrade

Ideally we should have popped these on a Mautic 3 branch but we only started these docs from Mautic 4 onwards.

Suggestion: Branch from 4.x to create a 3.x branch (it will be quite similar) and then add the docs for the upgrade and create the redirect.

Note: URLS to redirect:

https://docs.mautic.org/en/mautic-3-upgrade/getting-started
https://docs.mautic.org/en/mautic-3-upgrade/upgrade-steps

Review installing from Github https://docs.mautic.org/en/setup/how-to-install-mautic/install-mautic-from-github and move to the new documentation

• add screenshots where necessary

• proofread the documentation

• make changes where necessary

• add additional information that would be useful

High level issue to track the completion of the Components section.

• #44 Assets
• #45 DWC
• #46 Forms
• #47 Landing Pages

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

When we get to the segment section we need to incorporate this new feature into the documentation.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

The official documentation for creating themes says that "At present, Mautic won’t process the mj-head tags. None of the mj-attribuites run, so you have to do all styling inline."

But it turns out, as discussed in the forums, that mj-style tags inside mj-head tags do indeed work. As a new Mautic user who followed the documentation, it would've saved some time to have known that mj-style tags can be used from the start.

The docs should mention that mj-style tags can be used for styling. At present the mj-style tags are not mentioned.

<mj-head>
	<mj-style>
Styling here
	</mj-style>
  </mj-head>
<mj-body>