mahara-contributors team mailing list archive

[Kristina Hoeppner <1987718@xxxxxxxxxxxxxxxxxx>]

Public bug reported:

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.

** Affects: mahara
     Importance: Medium
         Status: In Progress

-- 
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: mahara-contributors
https://bugs.launchpad.net/bugs/1987718

Title:
  Add customisations.md file to capture customisations

Status in Mahara:
  In Progress

Bug description:
  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.

To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1987718/+subscriptions