Skip to content

feat: allow disabling user tours - #34182

Merged
Agrendalath merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/allow-disabling-user-tours
Feb 7, 2024
Merged

feat: allow disabling user tours#34182
Agrendalath merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/allow-disabling-user-tours

Conversation

@Agrendalath

Copy link
Copy Markdown
Member

Description

Currently, there is no way to disable user tours. There used to be a similar waffle flag, but it was dropped in 2038633.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

  1. Run the following snippet in the Django shell:
     from django.contrib.auth.models import User
     from lms.djangoapps.user_tours.models import UserTour
    
     UserTour.objects.update_or_create(user=User.objects.get(username='edx'), defaults=dict(course_home_tour_status='show-new-user-tour', show_courseware_tour=True))
  2. Log in as an edx user.
  3. In LMS, visit the Course Outline page of the Demo course and see that the user tour is displayed.
  4. Create a Waffle flag (/admin/waffle/flag/) called user_tours.tours_disabled and set it to Yes.
  5. Load the Course Outline page again and see that the tours are no longer displayed.

Deadline

"None"

Other information

Private-ref: BB-8396

@Agrendalath Agrendalath self-assigned this Feb 5, 2024
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 5, 2024
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @Agrendalath! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@navinkarkera navinkarkera left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Agrendalath Looks good.:+1:

  • I tested this: (Disabled tours in my local setup using the flag)
  • I read through the code

Comment thread lms/djangoapps/user_tours/toggles.py Outdated
A similar waffle flag was dropped in 2038633.
@Agrendalath
Agrendalath force-pushed the agrendalath/allow-disabling-user-tours branch from 96a77e6 to e089fa5 Compare February 6, 2024 12:47
@Agrendalath
Agrendalath merged commit 21f2e30 into openedx:master Feb 7, 2024
@Agrendalath
Agrendalath deleted the agrendalath/allow-disabling-user-tours branch February 7, 2024 16:14
@openedx-webhooks

Copy link
Copy Markdown

@Agrendalath 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants