Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-900

Installation documentation needs improving

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Component/s: docs.moodle.org
    • Labels:
      None

      Description

      The installation instructions are one of the most important parts of the documentation and it has become really hard to use with some information now (apparently) missing completely (e.g. minimum software versions).

      For example, a vital step is to ensure your database is set to UTF8. The path to find this is....

      http://docs.moodle.org/
      http://docs.moodle.org/en/Administrator_documentation
      http://docs.moodle.org/en/Administrator_documentation#Installation_.26_Upgrading
      http://docs.moodle.org/en/Installing_Moodle
      http://docs.moodle.org/en/Installing_Moodle#Create_empty_database
      http://docs.moodle.org/en/Create_Moodle_site_database
      http://docs.moodle.org/en/Create_Moodle_site_database#MySQL

      ....and finally you get the correct steps to create a database and set it up properly. That's 7 steps and only because I knew I was looking for it. There's no was a naive user will stumble across this unless they happen to be the type that reads documentation comprehensively. This isn't an obscure case either. It's setting up a MySQL database on a Unix type distribution which (even conservatively) must account for over 50% of installation scenarios.

      It used to be much easier before it was "improved" by splitting it all up.

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Votes:
                  1 Vote for this issue
                  Watchers:
                  1 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: