developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Improve the Matomo developer getting started guide

Open bx80 opened this issue 1 year ago • 2 comments

The developer getting started guide 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

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!

bx80 avatar Dec 06 '23 03:12 bx80

This issue has been mentioned on Matomo forums. There might be relevant details there:

https://forum.matomo.org/t/my-trials-installing-a-matomo-fork-on-wsl2-windows-11/54015/3

@bx80 we have an initiative that can address majority of these issues, I'll add a link to this issue so that we are aware of it. Should this issue be moved to the documentation repo, too?

michalkleiner avatar Dec 06 '23 04:12 michalkleiner