Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
OmarIthawi opened this issue Sep 12, 2017 · 1 comment

Comments

@OmarIthawi
Copy link
Member

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
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant