Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-80509

Prompt to register site after all upgrades

XMLWordPrintable

    • MOODLE_404_STABLE
    • MOODLE_404_STABLE
    • master_MDL-80509
    • Hide

      Ensure you are using a publicly available URL for your site $CFG->wwwroot, e.g. Ngrok

      Tests for a "public" site:

      1. Install site and login as admin
      2. When the admin menu is accessed you should see the registration form. (this is the same behaviour prior to the patch)
      3. Click the "skip" link, don't register the site.
      4. Bump the Moodle version number in `version.php` e.g from 2023021700.00 to 2023021700.01
      5. upgrade the site from the CLI
      6. When the admin menu is accessed after upgrade you should see the registration form. (new behaviour)
      7. Click the "skip" link, don't register the site.
      8. Bump the Moodle version number in `version.php` e.g from 2023021700.01 to 2023021700.02
      9. Upgrade the site from the web ui
      10. When the admin menu is accessed after upgrade you should see the registration form. (new behaviour)
      11. Click the "skip" link, don't register the site.
      12. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900 to 2023100900.01
      13. upgrade the site from the CLI
      14. When the admin menu is accessed after upgrade you should see the registration form. (new behaviour)
      15. Click the "skip" link, don't register the site.
      16. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900.01 to 2023100900.02
      17. Upgrade the site from the web ui
      18. When the admin menu is accessed after upgrade you should see the registration form. (new behaviour)
      19. Click the "skip" link, don't register the site.

       

      Tests for a non public site:

      1. Set site to be not public `config.php`: $CFG->site_is_public = false;`
      2. Bump the Moodle version number in `version.php` e.g from 2023021700.02 to 2023021700.03
      3. upgrade the site from the CLI
      4. When the admin menu is accessed after upgrade you should NOT see the registration form.
      5. Bump the Moodle version number in `version.php` e.g from 2023021700.03 to 2023021700.04
      6. Upgrade the site from the web ui
      7. When the admin menu is accessed after upgrade you should NOT see the registration form.
      8. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900 to 2023100900.01
      9. upgrade the site from the CLI
      10. When the admin menu is accessed after upgrade you should NOT see the registration form.
      11. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900.01 to 2023100900.02
      12. Upgrade the site from the web ui
      13. When the admin menu is accessed after upgrade you should NOT see the registration form.
      Show
      Ensure you are using a publicly available URL for your site $CFG->wwwroot , e.g. Ngrok Tests for a "public" site: Install site and login as admin When the admin menu is accessed you should see the registration form. (this is the same behaviour prior to the patch) Click the "skip" link, don't register the site. Bump the Moodle version number in `version.php` e.g from 2023021700.00 to 2023021700.01 upgrade the site from the CLI When the admin menu is accessed after upgrade you should see the registration form. (new behaviour) Click the "skip" link, don't register the site. Bump the Moodle version number in `version.php` e.g from 2023021700.01 to 2023021700.02 Upgrade the site from the web ui When the admin menu is accessed after upgrade you should see the registration form. (new behaviour) Click the "skip" link, don't register the site. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900 to 2023100900.01 upgrade the site from the CLI When the admin menu is accessed after upgrade you should see the registration form. (new behaviour) Click the "skip" link, don't register the site. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900.01 to 2023100900.02 Upgrade the site from the web ui When the admin menu is accessed after upgrade you should see the registration form. (new behaviour) Click the "skip" link, don't register the site.   Tests for a non public site: Set site to be not public `config.php`: $CFG->site_is_public = false;` Bump the Moodle version number in `version.php` e.g from 2023021700.02 to 2023021700.03 upgrade the site from the CLI When the admin menu is accessed after upgrade you should NOT see the registration form. Bump the Moodle version number in `version.php` e.g from 2023021700.03 to 2023021700.04 Upgrade the site from the web ui When the admin menu is accessed after upgrade you should NOT see the registration form. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900 to 2023100900.01 upgrade the site from the CLI When the admin menu is accessed after upgrade you should NOT see the registration form. Bump the version number for a plugin. e.g admin/tool/log/version.php from 2023100900.01 to 2023100900.02 Upgrade the site from the web ui When the admin menu is accessed after upgrade you should NOT see the registration form.
    • 2
    • Team Hedgehog 2023 Sprint 4.3, Team Hedgehog 2023 Review 4

      Currently the form to register a site only appears: once after site install and again after every major upgrade.

      An admin can choose to register a site at a later date and there is a registration call to action on admin pages for unregistered sites. However, neither of these are particularly effective at getting administrators to register.

      Registered sites provide key (anonymous) information to Moodle HQ, that assists in how we manage, design and support Moodle LMS; so it is important that site admins register their sites.

      This patch displays the site registration form to admins after every upgrade, including plugin installs and updates. To further encourage them to register their site.

      The new registration prompt will NOT display if:

      • The site is already registered
      • The site is not set to be public: `$CFG->site_is_public = false;`

      If registration is skipped it won't display again until the next upgrade (or if the site was registered).

      It will not nag developers who upgrade all the time as part of their dev/test workflows (providing they set: `$CFG->site_is_public = false;`)

       

      Patch notes:

      The patch removes the config setting that triggers the registration reminder in the core upgrade function and moves it to the non-core upgrade method.
      This is because the non core upgrade is always triggered when the core upgrade method is. So the one setting update covers both core and non-core upgrades, no need to duplicate it.

      In the CLI upgrade.php script non-core upgrades are always called. Core upgrades are conditionally called. The same is true for admin index.php (core, non-core).

        1. MDL-80509-non public.png
          MDL-80509-non public.png
          505 kB
        2. MDL-80509-public.png
          MDL-80509-public.png
          440 kB

            matt.porritt@moodle.com Matt Porritt
            matt.porritt@moodle.com Matt Porritt
            Meirza Meirza
            Huong Nguyen Huong Nguyen
            Ron Carl Alfon Yu Ron Carl Alfon Yu
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 4 hours, 22 minutes
                4h 22m

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.