Mautic community handbook

A handbook for all things related to the Mautic Community.

To contribute please make a PR for review by the Community Leadership Team.

Local development setup

Mautic uses DDEV to simplify local development and testing of documentation updates.

Go to the Get Started page for instructions to install DDEV on your local machine.

---

Note

For Windows users: You can install and run DDEV on traditional Windows. However, it's recommended that you use Windows Subsystem for Linux 2 (WSL2) for faster and better performance.

If you're new to WSL, follow the instructions on the DDEV blog to install and set up WSL and DDEV.

---

After you've installed DDEV, follow these steps:

1. Fork and clone this repository to your local machine.

2. Navigate into the project directory by running:

   cd mautic-community-handbook

3. Start the DDEV environment with this command:

   ddev start

4. After making changes to documentation files, you need to build the updated docs by running:

   ddev build-docs

5. Run the below command to view your changes live on your browser:

   ddev launch

   This automatically opens your browser and navigates to https://mautic-community-handbook.ddev.site/.

   Note: You must ensure that your changes work as expected. Every time you make changes, run ddev build-docs and refresh the page in your browser to see the changes.

Tip

If you don't see the configuration take effect, run ddev restart to restart the project.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Gábor Hojtsy 📖	Sven Döring 📖	Déborah Salves 📖	Oluwatobi Owolabi 👀	Ruth Cheesley 👀	IonutOjicaDE 👀 📖	Daniel Lord 👀
domidc 📖	Vibhuti 📖	Rita Onwudiwe 📖	Ayu Adiati 📖	Peace Sandy 📖	Favour Kelvin 👀	ashmita_ 📖
Favour Chibueze 📖	Susan Odii 📖	Dalton McGehee 📖	Judith Etugbo 📖

This project follows the all-contributors specification. Contributions of any kind welcome!