Moodle Community Sites

Installation documentation needs improving

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Critical 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.

Issue Links

Activity

Hide
Helen Foster added a comment -

What we really need is a complete reorganisation and update of all pages in http://docs.moodle.org/20/en/Category:Installation so that newcomers to Moodle have easy to understand documentation on installing Moodle.

Show
Helen Foster added a comment - What we really need is a complete reorganisation and update of all pages in http://docs.moodle.org/20/en/Category:Installation so that newcomers to Moodle have easy to understand documentation on installing Moodle.
Hide
Helen Foster added a comment -

I've done a first pass through http://docs.moodle.org/21/en/Category:Installation and deleted a bunch of pages which are not relevant to Moodle 2.x. Please find below my notes about the remaining pages after looking through them with Koen.

Key pages

i.e. pages which should be included in the TOC, though perhaps need the text rearranging over more or fewer pages

Text from the original Installing Moodle page was rearranged over the following pages (some with rather weird page names). Perhaps it should be put back on one page?

Perhaps the content of the following pages could be rearranged over 3 pages about installing Moodle on Windows, Linux and Mac:

Text from the Cron page has recently been rearranged over the following pages as proposed in http://docs.moodle.org/21/en/Talk:Cron Is this a sensible way of organising things, or is it better to keep all the info on one page?

Documentation about other software

Should this info be included in Moodle Docs or should we just include links to other sites where the info can be found?

Less significant pages

i.e. pages with can be kept in the installation category but not included in the TOC or info moved to other pages and then deleted

Please note that I'm certainly no expert in installing Moodle so some of the above notes may be totally wrong! Feedback and further comments would be much appreciated. Finally Howard, you should feel free to reorganise and improve the installation documentation as you see best!

Show
Helen Foster added a comment - I've done a first pass through http://docs.moodle.org/21/en/Category:Installation and deleted a bunch of pages which are not relevant to Moodle 2.x. Please find below my notes about the remaining pages after looking through them with Koen.

Key pages

i.e. pages which should be included in the TOC, though perhaps need the text rearranging over more or fewer pages Text from the original Installing Moodle page was rearranged over the following pages (some with rather weird page names). Perhaps it should be put back on one page? Perhaps the content of the following pages could be rearranged over 3 pages about installing Moodle on Windows, Linux and Mac: Text from the Cron page has recently been rearranged over the following pages as proposed in http://docs.moodle.org/21/en/Talk:Cron Is this a sensible way of organising things, or is it better to keep all the info on one page?

Documentation about other software

Should this info be included in Moodle Docs or should we just include links to other sites where the info can be found?

Less significant pages

i.e. pages with can be kept in the installation category but not included in the TOC or info moved to other pages and then deleted Please note that I'm certainly no expert in installing Moodle so some of the above notes may be totally wrong! Feedback and further comments would be much appreciated. Finally Howard, you should feel free to reorganise and improve the installation documentation as you see best!
Hide
Howard Miller added a comment -

Having been working on this for a few days now my driving policy is to make the information more succinct. I think the documentation has become spread over too many pages and some of it has become incredibly verbose (not in a good way).

I'm happy to be overruled but I believe that we can/should expect users to have at least a superficial understanding of the platform that they are attempting to install Moodle on. It just becomes an unwieldy nightmare otherwise!

Show
Howard Miller added a comment - Having been working on this for a few days now my driving policy is to make the information more succinct. I think the documentation has become spread over too many pages and some of it has become incredibly verbose (not in a good way). I'm happy to be overruled but I believe that we can/should expect users to have at least a superficial understanding of the platform that they are attempting to install Moodle on. It just becomes an unwieldy nightmare otherwise!
Hide
Helen Foster added a comment -

+1 for making the information more succinct and expecting a basic understanding. Thanks Howard

Show
Helen Foster added a comment - +1 for making the information more succinct and expecting a basic understanding. Thanks Howard
Hide
Martin Dougiamas added a comment -

Good luck! Looking forward to seeing what you come up with!

Show
Martin Dougiamas added a comment - Good luck! Looking forward to seeing what you come up with!
Hide
Helen Foster added a comment -

Just came across a couple more key pages which I think should be included in the installation category:

http://docs.moodle.org/21/en/Git_for_Administrators
http://docs.moodle.org/21/en/CVS_for_Administrators

Show
Helen Foster added a comment - Just came across a couple more key pages which I think should be included in the installation category: http://docs.moodle.org/21/en/Git_for_Administrators http://docs.moodle.org/21/en/CVS_for_Administrators
Hide
Howard Miller added a comment -

Yep - already attacked the Git one. The main install pages and those that link directly from them should be more or less done. I keep revisiting pages as I find other information I didn't know existed but you should get the spirit of it if you want to have a look.

Comments appreciated.

I'll try to keep a list of pages I have updated to make it easier to copy them to 2.2.

Show
Howard Miller added a comment - Yep - already attacked the Git one. The main install pages and those that link directly from them should be more or less done. I keep revisiting pages as I find other information I didn't know existed but you should get the spirit of it if you want to have a look. Comments appreciated. I'll try to keep a list of pages I have updated to make it easier to copy them to 2.2.
Hide
Helen Foster added a comment -

Many thanks for your docs work, Howard. Whilst the wikis will always be work-in-progress, I think it's time to mark this issue as resolved.

Show
Helen Foster added a comment - Many thanks for your docs work, Howard. Whilst the wikis will always be work-in-progress, I think it's time to mark this issue as resolved.
Hide
Martin Dougiamas added a comment -

Thanks very much for your help Howard.

Show
Martin Dougiamas added a comment - Thanks very much for your help Howard.

People

Vote (1)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: