kerongon / moodle-local_nudge

The Nudge plugin for MOODLE and Totara aims to provide a simple way to notify/remind users to revisit their course prior to course completion.

👉 Nudge

The Nudge plugin for MOODLE and Totara aims to provide a simple way to notify/remind users to revisit their course prior to course completion.

The pugin supports multiple translation, templated messages, recurring remind dates, relative remind dates and the option to remind managers in both Totara and MOODLE.

Table of contents
What this is not
Contributing
Versioning
Installation
Credits

Documentation

Proper documentation is provided in the Docs Folder beginning at Documentation.

What this is not

• A magic wand that induces instant compliance
• A activity completion reminding system for that we'd recommend the Re-engagement Activity.
• A complex system, The entirety of the completion checks for this plugin reside in a single call to:

  (new completion_info($course))->is_course_complete($userid)

• Fast - This plugin is not designed to be fast and efficient its designed to be easy to work with and test. If you have issues with the processing time of the Nudge Task, submit a feature flag gated PR or run it on a worker.

Contributing

Welcomed :-)

Versioning

PHP Version	LMS Version	Nudge Branch
	MOODLE
7.4	< MOODLE_39_STABLE	Not tested
7.4	MOODLE_39_STABLE	main
7.4	MOODLE_310_STABLE	main
7.4	MOODLE_311_STABLE	main
7.4	MOODLE_40_STABLE	Not tested
7.4	> MOODLE_40_STABLE	Not tested
	Totara
7.4	< Totara 13	Not tested
7.4	Totara 13	main
7.4	Totara 14	Not tested
7.4	Totara 15	main
7.4	> Totara 15	Not tested

Installation

TODO - Install Instructions.

1. ⚠️ MUST review and follow File Security for a secure install.

Credits

• Bradken for sponsoring the development of this plugin and allowing us to share it with the community.
• Catalyst IT for sharing their plugins publicly as great architecture references and learning material.