From 3588ec7a399895c7cfe4a6e566acce2cfa12be9a Mon Sep 17 00:00:00 2001 From: Tim McCormack Date: Mon, 30 Oct 2023 10:06:51 -0400 Subject: [PATCH] docs: Hint regarding plugin_app (#356) Make it explicit that plugin_app is a required field even if it is empty. --- .../plugins/docs/how_tos/how_to_create_a_plugin_app.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst b/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst index 76555435..ef3287eb 100644 --- a/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst +++ b/edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst @@ -32,7 +32,7 @@ file:: 3. (optional, but recommended) Create a top-level settings/ directory with common.py and production.py modules. This will allow you to use the PluginSettings.CONFIG option as written below. -4. configure the Plugin App in their AppConfig. Note that in this example, we are explicitly configuring plugins for use in edx-platform. If your plugin is going to be used in another IDA, you may have different project and settings types. You will need to look at the IDA in question for what values it expects. You may want to add new values to the relevant enums. +4. configure the Plugin App in their AppConfig. The app must have a ``plugin_app`` field set to a dictionary, even if the dictionary is empty. Note that in this example, we are explicitly configuring plugins for use in edx-platform. If your plugin is going to be used in another IDA, you may have different project and settings types. You will need to look at the IDA in question for what values it expects. You may want to add new values to the relevant enums. class::