Moodle
  1. Moodle
  2. MDL-37145

Documentation for caching admin screens

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Blocker Blocker
    • Resolution: Unresolved
    • Affects Version/s: 2.4, 2.5.3, 2.6
    • Fix Version/s: BACKEND
    • Component/s: Caching, Documentation
    • Labels:
    • Affected Branches:
      MOODLE_24_STABLE, MOODLE_25_STABLE, MOODLE_26_STABLE
    • Story Points:
      40
    • Rank:
      55307
    • Sprint:
      BACKEND Sprint 12

      Description

      We need to add much more docs to explain what is going on in the caching plugin screens.

      People are complaining about it on the forums:
      https://moodle.org/mod/forum/discuss.php?d=217195

        Activity

        Hide
        Dan Poltawski added a comment -

        I've added some very basic info to http://docs.moodle.org/24/en/Caching#How_to_use_the_caching_settings

        Some thoughts I had when I was writing it:

        • 'Installed cache stores' could be renamed 'Cache Plugins'?
        • 'Configured store instances' could be encapsulated inside the above table, so you could have a top level Plugin and then instance management under them.
        • 'Known cache definitions' could be renamed something less developery, maybe 'Moodle caches'?
        • 'Stores used when no mapping is present' could be renamed 'Default cache stores' or something like that?
        • 'Stores used when no mapping is present' feels more logical to me above 'Stores used when no mapping is present' (i.e. defaults at top, and then tweak the configuration for individual caches below)
        • 'Summary of cache lock instances.' - is this worth having visible to normal admins? I guess I can't tell because there are no other cache lock instances
        • Do we need 'Rescan definitions' for non-developers?
        Show
        Dan Poltawski added a comment - I've added some very basic info to http://docs.moodle.org/24/en/Caching#How_to_use_the_caching_settings Some thoughts I had when I was writing it: 'Installed cache stores' could be renamed 'Cache Plugins'? 'Configured store instances' could be encapsulated inside the above table, so you could have a top level Plugin and then instance management under them. 'Known cache definitions' could be renamed something less developery, maybe 'Moodle caches'? 'Stores used when no mapping is present' could be renamed 'Default cache stores' or something like that? 'Stores used when no mapping is present' feels more logical to me above 'Stores used when no mapping is present' (i.e. defaults at top, and then tweak the configuration for individual caches below) 'Summary of cache lock instances.' - is this worth having visible to normal admins? I guess I can't tell because there are no other cache lock instances Do we need 'Rescan definitions' for non-developers?
        Hide
        Luciano Silva added a comment -

        I configured memcached in mdl 2.5, but the parameters are not clear. I would appreciate your help improving cache docs.

        Tks

        Show
        Luciano Silva added a comment - I configured memcached in mdl 2.5, but the parameters are not clear. I would appreciate your help improving cache docs. Tks
        Hide
        Dan Poltawski added a comment -

        More people struggling with this in this thread: https://moodle.org/mod/forum/discuss.php?d=251547

        I'm raising the priority to blocker since really this is way past overdue and adding to the backend backlog.

        Show
        Dan Poltawski added a comment - More people struggling with this in this thread: https://moodle.org/mod/forum/discuss.php?d=251547 I'm raising the priority to blocker since really this is way past overdue and adding to the backend backlog.
        Hide
        Mary Cooch added a comment -

        This would be much appreciated as it's not something I understand -if someone wants to add information to the 2.6 docs I am happy to copy and paste over to the others.

        Show
        Mary Cooch added a comment - This would be much appreciated as it's not something I understand -if someone wants to add information to the 2.6 docs I am happy to copy and paste over to the others.
        Hide
        Ankit Agarwal added a comment -

        I will make sure this gets in, in next sprint.

        Show
        Ankit Agarwal added a comment - I will make sure this gets in, in next sprint.
        Hide
        Howard Miller added a comment -

        I hope I don't sound insulting, but this seems to have been created from a "computer science" point of view (i.e., a theoretical understanding of cacheing) as opposed to a practical, end-user viewpoint.

        Caching needs to be straightforward for an average administrator to set up. That is the perspective all naming and help must be written from.

        To make matters worse, in many configurations a mis-configured MUC will kill the performance of a Moodle site so it isn't a "nice to have". This is properly critical stuff and needs some time and thought.

        Show
        Howard Miller added a comment - I hope I don't sound insulting, but this seems to have been created from a "computer science" point of view (i.e., a theoretical understanding of cacheing) as opposed to a practical, end-user viewpoint. Caching needs to be straightforward for an average administrator to set up. That is the perspective all naming and help must be written from. To make matters worse, in many configurations a mis-configured MUC will kill the performance of a Moodle site so it isn't a "nice to have". This is properly critical stuff and needs some time and thought.
        Hide
        Dan Poltawski added a comment -

        Hi Howard,

        Not sure what you are referring to what you say 'this seems to have been created'?

        Show
        Dan Poltawski added a comment - Hi Howard, Not sure what you are referring to what you say 'this seems to have been created'?
        Hide
        Howard Miller added a comment -

        The caching user interface. While I understand that it gives a great deal of flexibility - the terminology will go right over the heads of most users (especially given the lack of help and documentation). It would have been better IMO, to allow certain common scenarios to be selected and then have advanced settings for those that need them.

        Show
        Howard Miller added a comment - The caching user interface. While I understand that it gives a great deal of flexibility - the terminology will go right over the heads of most users (especially given the lack of help and documentation). It would have been better IMO, to allow certain common scenarios to be selected and then have advanced settings for those that need them.

          People

          • Votes:
            8 Vote for this issue
            Watchers:
            9 Start watching this issue

            Dates

            • Created:
              Updated:

              Agile