Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: devstack settings #448

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: devstack settings #448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions edx_django_utils/plugins/docs/how_tos/how_to_create_a_plugin_app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,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.
3. (optional, but recommended) Create a top-level settings/ directory with common.py, devstack.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. 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.

Expand Down Expand Up @@ -101,14 +101,16 @@ class::

# Configure each settings, as needed.
'production': {

# The python path (relative to this app) to the settings module for the relevant Project Type and Settings Type.
# Optional; Defaults to 'settings'.
PluginSettings.RELATIVE_PATH: 'settings.production',
},
'common': {
PluginSettings.RELATIVE_PATH: 'settings.common',
},
'devstack': {
PluginSettings.RELATIVE_PATH: 'settings.devstack',
},
}
},

Expand Down Expand Up @@ -174,6 +176,7 @@ OR use string constants when they cannot import from djangoapps.plugins::
'lms.djangoapp': {
'production': { 'relative_path': 'settings.production' },
'common': { 'relative_path': 'settings.common' },
'devstack': { 'relative_path': 'settings.devstack' },
}
},
'signals_config': {
Expand Down