Skip to content

[TSD] Add FEATURES[‘ENABLE_EDXNOTES’] documentation #26203

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.

Sign up for GitHub

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

Closed
NeOneSoft wants to merge 7 commits into from
Closed

[TSD] Add FEATURES[‘ENABLE_EDXNOTES’] documentation #26203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ddb2c47
Adding FEATURES[‘ENABLE_EDXNOTES’] documentation
NeOneSoft Jan 28, 2021
425fd97
fix PEP8 W291 trailing whitespace
NeOneSoft Jan 28, 2021
5d62b90
fix too long lines
NeOneSoft Jan 28, 2021
931b4b6
adding specified django settings for edx-notes-api
NeOneSoft Jan 28, 2021
0b5de99
change toggle_description
NeOneSoft Jan 28, 2021
3434f3b
checking CI tests
NeOneSoft Jan 28, 2021
d686427
update PR comments
NeOneSoft Jan 29, 2021
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
4 changes: 1 addition & 3 deletions cms/envs/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,7 @@
# Turn off Video Upload Pipeline through Studio, by default
'ENABLE_VIDEO_UPLOAD_PIPELINE': False,

# let students save and manage their annotations
# for consistency in user-experience, keep the value of this feature flag
# in sync with the one in lms/envs/common.py
# See LMS annotations for details.
'ENABLE_EDXNOTES': False,

# Toggle to enable coordination with the Publisher tool (keep in sync with lms/envs/common.py)
Expand Down
13 changes: 12 additions & 1 deletion lms/envs/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,18 @@
# Show the mobile app links in the footer
'ENABLE_FOOTER_MOBILE_APP_LINKS': False,

# Let students save and manage their annotations

# .. toggle_name: FEATURES['ENABLE_EDXNOTES']
# .. toggle_implementation: SettingToggle
# .. toggle_default: False
# .. toggle_description: This toggle enables the students to save and manage their annotations in the
# course using the notes service. The bulk of the actual work in storing the notes is done by
# by a separate service(see the edx-notes-api repo).
# .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings
# EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API. If you update this setting, also update in Studio.
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2015-01-04
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/6321
'ENABLE_EDXNOTES': False,

# Toggle to enable coordination with the Publisher tool (keep in sync with cms/envs/common.py)
Expand Down