search

mautic / mautic-community-handbook

A handbook for all things related to the Mautic Community
https://contribute.mautic.org
7 stars 24 forks source link

Update reference to index_dev.php on developer mode section #184

Open RCheesley opened 8 months ago

RCheesley commented 8 months ago

There's an outdated reference here:

https://contribute.mautic.org/contributing-to-mautic/tester?_gl=1*1in3zx3*_ga*NDQ4MTgzODAxLjE3MDY2MjAyNjQ.*_ga_ZRB8436CFL*MTcwNjcwMTE5MS43LjEuMTcwNjcwMTI3NC4zOC4wLjA.#using-developer-mode

This should refer to the .env file now.

RCheesley commented 8 months ago

https://devdocs.mautic.org/en/5.x/development-environment/environments.html I think maybe we should centralise the information here, to avoid duplication?

amanreddy77 commented 2 months ago

hi @RCheesley can you explain me this issue in detail so that I will start working on this

RCheesley commented 1 month ago

Hi @amanreddy77 sure thing!

  1. We no longer have an index_dev.php, it was removed and we now use the environment file. You can read more about that in the link I shared, https://devdocs.mautic.org/en/5.x/development-environment/environments.html.

  2. We need to remove the references to index_dev.php which are on the Community Handbook (see https://github.com/search?q=repo%3Amautic%2Fmautic-community-handbook%20%22index_dev.php%22&type=code) and instead, explain about the environment file

  3. I wonder if we actually remove the section about setting up Mautic locally in the tester page, and instead direct them to the developer docs where we have that info written already? Reason being, is that now we have to maintain two sources of truth which is quite error prone. What do you think? Here's how to set up locally with DDEV: https://devdocs.mautic.org/en/5.x/development-environment/how_to_install_with_ddev.html and here's how to set up locally with an existing AMP stack: https://devdocs.mautic.org/en/5.x/development-environment/setup.html.