Package: edx-notices
This repo is not currently accepting open source contributionsOverviewThis plugin for edx-platform manages notices that a user must acknowledge. It only stores the content of the notices and whether a user has acknowledged them. Presentation and other client side decisions will be left to the frontends that utilize these APIs.This Django app contains notices that a user must acknowledge before continuing to use the site. This app will have two API endpoints to facilitate that:
1. An endpoint to return links to all notices that the user hasn’t acknowledged.
2. An endpoint to acknowledge that a user has seen the notice. This endpoint’s URL will be passed to the client via the first endpoint.Documentation(TODO:Set up documentation)Developing in DevstackMake sure the LMS container is running in Devstack, thengit clone git@github.com:edx/platform-plugin-notices.git <devstack_folder>/src
cd <devstack_folder>/devstack
make dev.shell.lms
pip install -e /edx/src/platform-plugin-notices
cd /edx/app/edxapp/edx-platform
./manage.py lms migrateOnce that is done, LMS will pickup the plugin and saves to existing files should cause a devserver restart with your changes. Occasionally when adding a new file, you may need to restart the LMS container in order for it to pickup the changes.Enabling the Notices Plugin in the LMSThe Notices plugin functionality is enabled via use of a waffle flag. After installation of the plugin you need to do the following in devstack:Log into the LMS Django Admin (http://localhost:18000/admin/)Add a new waffle flag (http://localhost:18000/admin/waffle/flag/add/)Name the waffle flagnotices.enable_noticesSetEveryonetoYesSave the waffle flag.LicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeThis repo is not currently accepting open source contributionsReporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.SupportIf you’re having trouble, we have discussion forums athttps://discuss.openedx.orgwhere you can connect with others in the community.Our real-time conversations are on Slack. You can request aSlack invitation, then join ourcommunity Slack workspace.For more information about these options, see theGetting Helppage.Change LogUnreleased[0.14.55] - 2023-09-25Fixed PyPI Publish workflow[0.14.53] - 2023-09-22Added Django 4.2 Support[0.14.20] - 2022-07-01Updating Python Requirements[0.14.15] - 2022-07-01Updating Python Requirements[0.14.11] - 2022-06-01Updating Python Requirements[0.14.4] - 2022-02-14Changed Do not redirect notices/render/{id}/ to login page in case of 403 on mobile request[0.14.3] - 2022-02-07Update pip-tools[0.14.2] - 2022-01-28Update Python dependencies[0.14.1] - 2022-01-05Update Python dependencies[0.14.0] - 2021-11-24Add logging[0.13.0] - 2021-11-24Added history table to AcknowledgedNotice[0.12.0] - 2021-11-2Added support for django 3.2 and dropped support for previous versions[0.11.8] - 2021-11-10Update Python dependencies[0.11.7] - 2021-11-10Add userLanguage flag so JavaScript-rendered text can be displayed in the correct language[0.11.6] - 2021-11-10Add mobile flag so mobile can be disabled in production[0.11.5] - 2021-11-09Add lang tag to HTML element[0.11.4] - 2021-11-08Change name of segment event from “acquisition” to “notice”[0.11.3] - 2021-11-05Allow user to leave page even if API call fails (important for mobile)[0.11.2] - 2021-11-04Updated Django admin form list display and searchable fields.[0.11.1] - 2021-10-29fix analytics key in template[0.11.0] - 2021-11-1Add in a setting to limit the number of days you can snooze a notice.[0.10.3] - 2021-10-29Fix dismiss button redirecting[0.10.2] - 2021-10-29fix analytics key[0.10.1] - 2021-10-29Limit notices to users who were created before it was released[0.10.0] - 2021-10-25Add segment library for event tracking[0.9.0] - 2021-10-25Add in a snooze limit feature that will only allow a notice to be snoozed a number of times[0.8.2] - 2021-10-21Update requirements[0.8.1] - 2021-10-21Add ability to reshow notice after a snooze period via setting[0.7.3] - 2021-10-20Make AcknowledgedNotice user editable in the admin for testing purposes[0.7.2] - 2021-10-19Make AcknowledgedNotice user readonly in the admin for performance[0.7.1] - 2021-10-19Add Waffle Flag to enable and disable the feature for rollout[0.6.1] - 2021-10-7Add Python API for retrieving unack’d and active notice dataAdd Plugin Context API for notice data to support redirects on the LMS Course Dashboard[0.5.1] - 2021-10-7Disallow dismissal after confirmation of notice[0.4.1] - 2021-10-7Allow inactive (non-email-verified) users to call APIs[0.3.1] - 2021-10-1Add mobile calls so notice code can deep link[0.2.2] - 2021-09-24Add fallback language on render viewAdd Bearer auth to APIs for mobileAdd login requirement to render viewAdd first edx-platform dependency[0.2.1] - 2021-09-22Utility functions for custom notice code to use to call APIs[0.1.1] - 2021-09-16Moved to server rendered notice modelAdd mandatory types to acknowledgement to track more states[0.1.0] - 2021-08-19First release on PyPI.