Add KOLIBRI_ENABLE_CUSTOM_CHANNEL_NAV - default True to options.py #8025
Conversation
There was a problem hiding this comment.
Let's scope this to the learn plugin.
Would also be helpful to expose this in the plugin data in Learn for ease of use: https://github.com/learningequality/kolibri/blob/release-v0.14.x/kolibri/plugins/learn/kolibri_plugin.py#L51
| "LEARN": { | ||
| "DISABLE_CUSTOM_CHANNEL_NAV": { | ||
| "type": "boolean", | ||
| "default": False, |
There was a problem hiding this comment.
The issue asks for this to be disabled by default, so if the flag is going to be DISABLE then this should default to True!
There was a problem hiding this comment.
Made it into an ENABLE name instead
kolibri/plugins/learn/options.py
Outdated
| @@ -0,0 +1,9 @@ | |||
| option_spec = { | |||
| "LEARN": { | |||
There was a problem hiding this comment.
If you're editing the default, can also make this Title Case, which seems to be our unwritten convention for options section names.
kolibri/plugins/learn/options.py
Outdated
| "DISABLE_CUSTOM_CHANNEL_NAV": { | ||
| "type": "boolean", | ||
| "default": False, | ||
| "envvars": ("DISABLE_CUSTOM_CHANNEL_NAV",), |
There was a problem hiding this comment.
We've also tended to prefix these with KOLIBRI_ - there's an open issue to just generate these names automatically to avoid this hullabaloo: #5754
If we can just prefix KOLIBRI_ here for now, would be good.
jonboiser
changed the title
Summary
Adds an option that will be picked up from the options.ini file or by env var called
DISABLE_CUSTOM_CHANNEL_NAV.It is not then used anywhere as (I believe) it is intended for future debugging and/or dev use during development of the new feature.
References
Fixes #7830
Reviewer guidance
See that I did what is said in the well written and clear documentation that I ought to have read