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

Include new User Tour for new installations and upgrades

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.2
    • Fix Version/s: 3.2
    • Component/s: User Tours
    • Labels:
    • Testing Instructions:
      Hide

      Test Tours

      1. Create a new install of Moodle with this patch
      2. Log in as admin
      3. Navigate to the user tours settings (site admin > appearance > user tours)
      4. Confirm that there are 2 user tours installed, Boost - administrator and Boost - course view
      5. Attempt to edit one (or both) of the tours by clicking the cog icon
      6. Confirm you are given a warning about editing a tour that is shipped with Moodle
      7. Cancel editing and attempt to edit one of the steps by clicking on the name of the tour and then the name of one of the steps
      8. Confirm you are given a warning about editing a tour that is shipped with Moodle
      9. Navigate to the site home
      10. Confirm the Boost - administrator tour begins. Step through the tour.
      11. Create a new course in the site
      12. View the course
      13. Confirm that the Boost - course view tour begins
      14. Repeat the course view tour a couple of times (click the "reset user tour on this page" link in the footer) with different permutations of editing mode on/off and the nav drawer open/closed. The steps that are displayed should change depending on those states.
      15. Log out

      Test upgrade

      1. Download the attached tour boost_administrator_test_updated.json and replace the tour in admin/tool/usertours/tours/boost_administrator.json with it.
      2. Download the attached tour additional_test_tour.json and add it to the admin/tool/usertours/tours/ directory
      3. Edit admin/tool/usertours/classes/manager.php and in the update_shipped_tours function change the $shippedtours variable by increasing the version of the boost_administrator.json key from 1 to 2 and add an additional key/value pair 'additional_test_tour.json' => 1,
      4. Bump the version in admin/tool/usertours/version.php from 2016112900 to 2016112901
      5. Edit admin/tool/usertours/db/upgrade.php and change the timestamps from 2016112900 to 2016112901 to make the upgrade run
      6. Log in to Moodle as admin
      7. Confirm the plugin update runs successfully
      8. Navigate to the user tours settings (site admin > appearance > user tours)
      9. Confirm there are now 3 tours (some other tour should have been added)
      10. View the steps for the Boost - administrator tour (click the name of the tour) and confirm that it was updated successfully. It should now have a first step called "TEST".
      11. Navigate to "Site home" and confirm that the Boost - administrator tour runs again (since it's been updated).
      12. Navigate to a course and confirm that the Boost - course view tour does not run again (since it wasn't updated)
      13. Navigate to the "Dashboard" and confirm that the newly added some other tour is run
      Show
      Test Tours Create a new install of Moodle with this patch Log in as admin Navigate to the user tours settings (site admin > appearance > user tours) Confirm that there are 2 user tours installed, Boost - administrator and Boost - course view Attempt to edit one (or both) of the tours by clicking the cog icon Confirm you are given a warning about editing a tour that is shipped with Moodle Cancel editing and attempt to edit one of the steps by clicking on the name of the tour and then the name of one of the steps Confirm you are given a warning about editing a tour that is shipped with Moodle Navigate to the site home Confirm the Boost - administrator tour begins. Step through the tour. Create a new course in the site View the course Confirm that the Boost - course view tour begins Repeat the course view tour a couple of times (click the "reset user tour on this page" link in the footer) with different permutations of editing mode on/off and the nav drawer open/closed. The steps that are displayed should change depending on those states. Log out Test upgrade Download the attached tour boost_administrator_test_updated.json and replace the tour in admin/tool/usertours/tours/boost_administrator.json with it. Download the attached tour additional_test_tour.json and add it to the admin/tool/usertours/tours/ directory Edit admin/tool/usertours/classes/manager.php and in the update_shipped_tours function change the $shippedtours variable by increasing the version of the boost_administrator.json key from 1 to 2 and add an additional key/value pair 'additional_test_tour.json' => 1, Bump the version in admin/tool/usertours/version.php from 2016112900 to 2016112901 Edit admin/tool/usertours/db/upgrade.php and change the timestamps from 2016112900 to 2016112901 to make the upgrade run Log in to Moodle as admin Confirm the plugin update runs successfully Navigate to the user tours settings (site admin > appearance > user tours) Confirm there are now 3 tours ( some other tour should have been added) View the steps for the Boost - administrator tour (click the name of the tour) and confirm that it was updated successfully. It should now have a first step called "TEST". Navigate to "Site home" and confirm that the Boost - administrator tour runs again (since it's been updated). Navigate to a course and confirm that the Boost - course view tour does not run again (since it wasn't updated) Navigate to the "Dashboard" and confirm that the newly added some other tour is run
    • Affected Branches:
      MOODLE_32_STABLE
    • Fixed Branches:
      MOODLE_32_STABLE
    • Pull Master Branch:
      MDL-56553-master-2

      Description

      Martin has suggested that he'd like to include some user tours for new installations, and for upgrades to highlight new features.

      This issue is a placeholder for those tours.

      I'll assign it to MD for the moment, and once we know what the content of those tours is we can create new langstrings for them, and add them to the install.php and upgrade.php as required.

        Attachments

        1. Add-a-block - current.png
          Add-a-block - current.png
          74 kB
        2. Add-a-block - right.png
          Add-a-block - right.png
          77 kB
        3. additional_test_tour.json
          0.4 kB
        4. boost_administrator_2.json
          2 kB
        5. boost_administrator_3.json
          2 kB
        6. boost_administrator_test_updated.json
          2 kB
        7. boost_course_view_2.json
          3 kB
        8. boost_course_view_3.json
          2 kB
        9. Customisation -RTL.png
          Customisation -RTL.png
          74 kB
        10. customization - RTL.png
          customization - RTL.png
          80 kB
        11. Open-the-nav-drawer - RTL.png
          Open-the-nav-drawer - RTL.png
          61 kB
        12. tour_export_6_1479968638.json
          2 kB

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  5/Dec/16