depr!: remove the site-configuration script #1215
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes overhangio#1207 The site-configuration script was required because we needed to utilize the custom lms.startup() call to set the site-configuration This is no longer required as of openedx/edx-platform#36302 Therefore, we deprecate it in favour of the create_or_update_site_configuration management command provided in edx-platform
| @@ -0,0 +1 @@ | |||
| - [Depreciation] Remove the unnecessary site-configuration script in favour of the create_or_update_site_configuration management command provided in edx-platform. (by @Danyal-Faheem) | |||
There was a problem hiding this comment.
- We should mark this a breaking change, just in case
- We can add a note to use lms create_or_update_site_config mgt command as a replacement
There was a problem hiding this comment.
I've already added the name of the management command in the changelog entry and mentioned its provided in edx-platform. Do you think we should add another line with a hyperlink to the command?
There was a problem hiding this comment.
Yes, the link can be helpful.
There was a problem hiding this comment.
Added the hyperlink.
DawoudSheraz
approved these changes
Mar 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1207.
This PR is dependent on overhangio/tutor-mfe#246 and overhangio/tutor-discovery#101.
The site-configuration script was required because we needed to utilize the custom lms.startup() call to set the site-configuration. This is no longer required as of openedx/edx-platform#36302. Therefore, we deprecate it in favour of the create_or_update_site_configuration management command provided in edx-platform.