Skip to content
This repository was archived by the owner on Mar 20, 2025. It is now read-only.

Best practices for feature flag changes and a niptuk for the code snippets #1590

Closed
OmarIthawi opened this issue Sep 12, 2017 · 2 comments
Closed

Comments

@OmarIthawi
Copy link

The documentation for feature flags mentions lms.env.json and similar files. I think it's worth mentioning (in the guideline) that Ansible is the recommended way for building such files.

Additionally, the documentations features Python code when mentioning JSON files. While one can guess and do the right thing. I'd rather see a JSON syntax instead of Python.

Python: Notice the missing double quotes " and the constant True:

FEATURES = {
    'LICENSING': True,
    ...

JSON: Notice the lowercase true and the double quotes ":

"FEATURES": {
    "LICENSING": true, 
    ...
@OmarIthawi
Copy link
Author

@grantgoodmanedX This is related to #1589. But since it's more of a general comment I filed it as an issue.

@sarina
Copy link
Contributor

sarina commented Mar 7, 2025

Closing this issue as it is quite old. If documentation issues exist on the new docs site, https://docs.openedx.org/en/latest/ , please open an issue at https://github.com/openedx/docs.openedx.org/issues/new/choose

@sarina sarina closed this as completed Mar 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants