matomo-org / matomo-org/developer-documentation
Improve the Matomo developer getting started guide
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 58
- Forks
- 88
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 13
Description
The [developer getting started guide](https://developer.matomo.org/guides/getting-started-part-1) is out of date and is missing key steps required to easily setup a local development environment for contributing to Matomo or creating plugins.
Specific issues:
- The git submodule update --init step is not detailed
- Initial folder permission instruction are not covered
- .htaccess files are not explained
- A best practice method for setting up local SSL certificates is not provided
- The guides doesn't explain workarounds for the visitor generator and SSL.
These issues are described in more detail in this [excellent forum post](https://forum.matomo.org/t/my-trials-installing-a-matomo-fork-on-wsl2-windows-11/54015)
The guide should be updated and improved so that developers can quickly setup a working Matomo environment by just following the guide without having to search for external info or figure issues out by looking at code!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the developer getting started guide linked in the issue and compare it with the referenced forum post. Review the git submodule update --init step, folder permissions, .htaccess files, local SSL setup, and visitor generator workarounds. Done means the guide covers these steps well enough to set up a working Matomo development environment without external research.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, php
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100