Merge pull request #26535 from edx/ziafazal/annotations_ENABLE_ANNOUNCEMENTS

[TSD] Added annotations for ENABLE_ANNOUNCEMENTS feature flag
This commit is contained in:
Braden MacDonald
2021-03-04 15:15:45 -08:00
committed by GitHub

View File

@@ -4,6 +4,17 @@
def plugin_settings(settings):
"""
Common settings for Announcements
.. toggle_name: FEATURES['ENABLE_ANNOUNCEMENTS']
.. toggle_implementation: SettingDictToggle
.. toggle_default: False
.. toggle_description: This feature can be enabled to show system wide announcements
on the sidebar of the learner dashboard. Announcements can be created by Global Staff
users on maintenance dashboard of studio. Maintenance dashboard can accessed at
https://{studio.domain}/maintenance
.. toggle_warnings: TinyMCE is needed to show an editor in the studio.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-08
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16496
"""
settings.FEATURES['ENABLE_ANNOUNCEMENTS'] = False
# Configure number of announcements to show per page