Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions docs/decisions/0022-settings-simplification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Implementation tracked by: https://github.com/openedx/edx-platform/issues/36215
Context
*******

OEP-45 declares that sites will configure each IDA's (indepently-deployable
OEP-45 declares that sites will configure each IDA's (independently-deployable
application's) Django settings with an ``<APPNAME>_CFG`` YAML file, parsed and
loaded by a single upstream-provided ``DJANGO_SETTINGS_MODULE``. This contrasts
with the Django convention, which is that sites override Django settings using
Expand Down Expand Up @@ -133,7 +133,7 @@ cited as a chief area of pain for Open edX developers and operators.
Discussions in the Named Release Planning and Build-Test-Release Working Groups
frequently are encumbered with confusion and uncertainty of what the default
settings are in edx-platform, how they differ from Tutor's default settings,
what settings can be overriden, and how to do so. Only a minority of developers
what settings can be overridden, and how to do so. Only a minority of developers
and operators fully understand the configuration logic described above
end-to-end; even for those that do, following this override chain for any given
Django setting is time-consuming and error-prone. CAT-1 bugs and high-severity
Expand Down Expand Up @@ -170,7 +170,7 @@ that we are landing on a solid settings structure for edx-platform, we'll
propose an OEP-45 update to generalize the structure to all deployable Open edX
Django applications.

Finally, based on what we learn throughout this process, our OEP-45 propsal
Finally, based on what we learn throughout this process, our OEP-45 proposal
will either recommend to:

1. Drop support for the ``<APPNAME>_CFG`` YAML files, or
Expand All @@ -181,7 +181,7 @@ will either recommend to:

At the time, we do not have enough information whether option 1 or 2 would be
more beneficial overall to the community.
`The discussion on this sub-decisision will continue on this GitHub issue <https://github.com/openedx/open-edx-proposals/issues/684>`_.
`The discussion on this sub-decision will continue on this GitHub issue <https://github.com/openedx/open-edx-proposals/issues/684>`_.

Target settings structure for edx-platform
==========================================
Expand Down Expand Up @@ -304,7 +304,7 @@ These steps are non-breaking unless noted.
providers that use these settings modules, as they will either need to
maintain local copies of these modules, or "rebase" their internal
settings modules onto (cms,lms)/envs/common.py. Update operator
documenation as needed.
documentation as needed.

2. Update OEP-45 to clarify that YAML configuration is
optional. Operators can opt out of YAML by deriving directly from
Expand Down Expand Up @@ -332,7 +332,7 @@ Here is an alternate structure that would de-dupe any shared LMS/CMS dev & test
logic by creating more shared modules within openedx/envs folder. Although
DRYer, this structure would increase the total number of edx-platform files and
potentially encourage more LMS-CMS coupling. So, we will not pursue this
structure, but will keep it in mind as an alternative if we enounter
structure, but will keep it in mind as an alternative if we encounter
difficulties with the plan laid out in this ADR.

* ``openedx/envs/common.py``
Expand Down
2 changes: 1 addition & 1 deletion requirements/constraints.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ django-stubs<6
# The team that owns this package will manually bump this package rather than having it pulled in automatically.
# This is to allow them to better control its deployment and to do it in a process that works better
# for them.
edx-enterprise==6.6.2
edx-enterprise==6.6.3

# Date: 2023-07-26
# Our legacy Sass code is incompatible with anything except this ancient libsass version.
Expand Down
2 changes: 1 addition & 1 deletion requirements/edx/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ edx-drf-extensions==10.6.0
# enterprise-integrated-channels
# openedx-authz
# openedx-learning
edx-enterprise==6.6.2
edx-enterprise==6.6.3
# via
# -c requirements/constraints.txt
# -r requirements/edx/kernel.in
Expand Down
2 changes: 1 addition & 1 deletion requirements/edx/development.txt
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@ edx-drf-extensions==10.6.0
# enterprise-integrated-channels
# openedx-authz
# openedx-learning
edx-enterprise==6.6.2
edx-enterprise==6.6.3
# via
# -c requirements/constraints.txt
# -r requirements/edx/doc.txt
Expand Down
2 changes: 1 addition & 1 deletion requirements/edx/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ edx-drf-extensions==10.6.0
# enterprise-integrated-channels
# openedx-authz
# openedx-learning
edx-enterprise==6.6.2
edx-enterprise==6.6.3
# via
# -c requirements/constraints.txt
# -r requirements/edx/base.txt
Expand Down
2 changes: 1 addition & 1 deletion requirements/edx/testing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ edx-drf-extensions==10.6.0
# enterprise-integrated-channels
# openedx-authz
# openedx-learning
edx-enterprise==6.6.2
edx-enterprise==6.6.3
# via
# -c requirements/constraints.txt
# -r requirements/edx/base.txt
Expand Down
Loading