[BD-38] Flags & Toggles

This is a living document to add all toggles & feature flags for the BD-38 project.

 

Flag

Description

PR#

Flag

Description

PR#

 

 

 

discussions.pages_and_resources_mfe

Adds a waffle flag to link to the new Pages & Resources view (MFE) experience in Studio.

Type:

CourseWaffleFlag

WaffleFlagCourseOverride

URI for selective courses:

/admin/waffle_utils/waffleflagcourseoverridemodel/

URI for Course Staff & Superusers:

/admin/waffle/flag/

UseCases:

  1. Show navigation for Pages & Resources in studio navigation bar (Dropdown).

  2. Show updated breadcrumbs on Studio Textbook page.

edx-platform#26965 @Kshitij Sobti

edx-platform#28472 @Ahtisham Shahid

edx-platform#28629 @Awais Ansari

discussions.override_discussion_legacy_settings

Adds a waffle flag to make discussion advance settings available. By enabling discussions.pages_and_resources_mfeflag, the advance settings disappear for the course. If you want to allow course teams to access these legacy settings in course advance settings, enable this flag.

Default: False

Discussion settings include

  • Studio Advanced Settings

    • Allow Anonymous Discussion Posts

    • Allow Anonymous Discussion Posts to Peers

    • Discussion Blackout Dates

    • Discussion Topic Mapping

  • LMS Instructor Dashboard

    • Discussions Tab

Type:

CourseWaffleFlag

WaffleFlagCourseOverride

URI for selective courses:

/admin/waffle_utils/waffleflagcourseoverridemodel/

URI for Course Staff & Superusers:

/admin/waffle/flag/

https://github.com/edx/edx-platform/pull/27961/

CourseEditLTIFieldsEnabledFlag

An existing flag was moved from the cms in edx-platform to xblock-lti-consumer. This allows both studio and lms to access this flag.

Type:

ConfigurationModel

URI for selective courses:

Current:

{CMS_URL}/admin/xblock_config/courseeditltifieldsenabledflag/1/change/

 

 

course_apps.proctoring_settings_modal_view

Currently, the Proctoring app card has -> icon, which redirects to another page in MFE. This is due to this waffle flag which enables / disables proctoring popup modal.

Type:

CourseWaffleFlag

WaffleFlagCourseOverride

/admin/waffle_utils/waffleflagcourseoverridemodel/

URI for Course Staff & Superusers:

/admin/waffle/flag/

UseCases:

  • Show Proctoring View as a Pop Up (Modal) in the course authoring MFE.

  • Show Proctoring a new Page in the course authoring MFE.

 

teams.enable_teams_app

Adds a waffle flag to enable/disable the teams app on the course authoring MFE
Type:

WaffleFlag

URI:

/admin/waffle/flag/

URI for Course Staff & Superusers:

UseCases:

  • Show teams course app card on the course authoring MFE

 

openresponseassessment.team_submissions

Enables Team-sets (ie, group) in place of discussion topics

Type:

WaffleFlag

WaffleFlagCourseOverride

URI:

/admin/waffle/flag/

UseCases:

  • Enable ORA Team submissions

 

discussions.enable_discussions_mfe

Enables the new discussions MFE for global staff, course staff and course admin roles, making the discussions tab link to the MFE and embedding the MFE in-context in the discussions XBlock.

Type

CourseWaffleFlag

URI:

/admin/waffle_utils/waffleflagcourseoverridemodel/

Use Cases:

  • Switch to the discussions MFE in place of the legacy forum UI

https://github.com/edx/edx-platform/pull/29285

discussions.enable_discussions_mfe_for_everyone

Enables the new discussions MFE for everyone, making the discussions tab link to the MFE and embedding the MFE in-context in the discussions XBlock.

In case this flag exists it overrides the discussions.enable_discussions_mfe flag.

Experience switching banner will appear in new MFE for everyone (including community TA and group community TA roles) except learners.

Type

CourseWaffleFlag

URI:

/admin/waffle_utils/waffleflagcourseoverridemodel/

Use Cases:

  • This will allow us to rollout discussions MFE for everyone without the risk of hindering moderation activities in case of any significant issues yet to be discovered.

https://github.com/openedx/edx-platform/pull/30292

discussions.enable_mfe_banner_for_learners

If enabled, experience switching banner will also appear for learners.

Type

CourseWaffleFlag

URI:

/admin/waffle_utils/waffleflagcourseoverridemodel/

Use Cases:

  • If we rollout new MFE to learners and for some reason (bugs, rollout issues, other requests), we have to allow learners to switch to legacy experience, this flag will be used to allow learners to switch across platform or for select courses.

https://github.com/openedx/edx-platform/pull/30564

learner_dashboard.enable_program_tab_view

Waffle flag to enable new tab view for LMS programs. The new UI for programs discussions dashboard (we have different tabs including Journey, Community, Live, Pathways)

Default: False

Type:

WaffleFlag

/admin/waffle_utils/waffleflagcourseoverridemodel/

URI:

/admin/waffle/flag/

Use Case:

The flag controls if we want to render new tab view for programs or not. This is the first step to enable for program discussions feature.

 

learner_dashboard.enable_masters_program_tab_view

Waffle flag to enable new tab view for learner portal e.g. master programs. The new UI for programs discussions dashboard (we have different tabs including Journey, Community, Live)

Default: False

Use Case:

The flag controls if we want to render new tab view for programs or not. This is the first step to enable for program discussions feature.

 

discussions.enable_new_structure_discussions

Waffle flag to enable the new topic structure for in context discussions.
Default: False

Use Case:

  • This will show the new open edx provider in the discussions providers list in the course authoring MFE.

  • This is to be used to rollout milestone 1.7

https://github.com/openedx/edx-platform/pull/29962

course_live.enable_course_live

Waffle flag to enable the course live app in the course authoring MFE

Default: False

Use Case:

  • Shows the Live course app card on the course authoring MFE

https://github.com/openedx/edx-platform/pull/29998

discussions.enable_learners_tab_in_discussions_mfe

Waffle flag to enable the learners tab in the discussions MFE.

Default: False

Use case:

  • Testing the new learners view in the discussions MFE.

 

discussions.enable_moderation_reason_codes

Waffle flag to enable support for the new edit and post close reason codes.

Default: False

Use case:

  • Testing the moderation codes features in the discussions MFE.

 

discussions.enable_reported_content_email_notifications

Waffle flag to toggle email notifications for reported content for moderators

Default: False

  • Testing email notifications for moderators for reported content

  • When Flag is ON, the following will be activated

    • You can see enable_notification setting in the discussion settings page within course-authoring MFE for course,

    • If this Flag is enabled and the setting is turned on via course-authoring MFE, the moderators within the course will receive an email with reported content if the content is in reported state 2 minutes after being initially reported. This email will be a call for action for all users with moderator privileges for the course.

https://github.com/openedx/edx-platform/pull/30187