Documentation is important, but updating the regular Mahara README file can lead to merge conflicts. Therefore, setting up a CUSTOMISATIONS file that is linked to from the README can help with that. While it wouldn't be the default file viewed when a repo is opened, it's easily accessible and can capture site specific information rather than keeping that in a separate document.
It would sit outside of the htdocs directory so it isn't deployed to a server when a site is installed. Because the file is committed into the repo so others working on the repository have access to it, it needs to be in Git rather than be ignored. Therefore, it should not contain sensitive information such as passwords or personal info.
Patch for "main" branch: https:/ /reviews. mahara. org/c/mahara/ +/13100