This repo is not currently accepting open source contributions
This 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.
(TODO: Set up documentation)
Make sure the LMS container is running in Devstack, then
git clone [email protected]: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 migrate
Once 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.
The 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 flag
notices.enable_notices - Set Everyone to Yes
- Save the waffle flag.
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
This repo is not currently accepting open source contributions
Please do not report security issues in public. Please email [email protected].
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For more information about these options, see the Getting Help page.