openedx / edx-django-utils

edX utilities for Django Application development.
https://edx.readthedocs.io/projects/edx-django-utils/en/latest/
Apache License 2.0
26 stars 20 forks source link

Non-existent SettingsType referenced how-to documentation #288

Closed rgraber closed 1 year ago

rgraber commented 1 year ago

The how-to for creating a new plugin app involves using the SettingsType enum, which does not exist. We should either add the enum or remove the references to it in the documentation.

A/C

rgraber commented 1 year ago

Replace SettingsType.PRODUCTION and SettingsType.COMMON in the documentation with the actual strings they refer to and reference that they can be found in edx-platform here: https://github.com/openedx/edx-platform/blob/599d5d054cd43b3ec7a291e38de96108dfa28e14/openedx/core/djangoapps/plugins/constants.py#L25 . Clarify that this is an example from edx-platform but other services may have their own strings set up.