From ddb2c472a877cb5428fdf04d084e6ab59f3669d6 Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Wed, 27 Jan 2021 19:23:55 -0600 Subject: [PATCH 1/7] =?UTF-8?q?Adding=20FEATURES[=E2=80=98ENABLE=5FEDXNOTE?= =?UTF-8?q?S=E2=80=99]=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lms/envs/common.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lms/envs/common.py b/lms/envs/common.py index e51a5168def7..4101e95fd920 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -434,6 +434,16 @@ '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: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts + # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in + # storing the notes is done 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 as well + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: None + # .. toggle_tickets: None 'ENABLE_EDXNOTES': False, # Toggle to enable coordination with the Publisher tool (keep in sync with cms/envs/common.py) From 425fd972120aabeb98fea33666216a383f81f6f0 Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Wed, 27 Jan 2021 21:51:10 -0600 Subject: [PATCH 2/7] fix PEP8 W291 trailing whitespace --- lms/envs/common.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 4101e95fd920..895aff501e1f 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -437,8 +437,8 @@ # .. toggle_name: FEATURES['ENABLE_EDXNOTES'] # .. toggle_implementation: SettingToggle # .. toggle_default: False - # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts - # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in + # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts + # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in # storing the notes is done 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 as well # .. toggle_use_cases: open_edx From 5d62b908712902f0e6d1d50b2e8e9ef58c5befc0 Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Thu, 28 Jan 2021 09:56:15 -0600 Subject: [PATCH 3/7] fix too long lines --- lms/envs/common.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 895aff501e1f..5d63d07e2afc 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -438,8 +438,8 @@ # .. toggle_implementation: SettingToggle # .. toggle_default: False # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts - # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. The bulk of the actual work in - # storing the notes is done by a separate service (see the edx-notes-api repo). + # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. + # The bulk of the actual work in storing the notes is done 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 as well # .. toggle_use_cases: open_edx # .. toggle_creation_date: None From 931b4b621c29cbbaeb103528b889abb707e18dd6 Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Thu, 28 Jan 2021 11:59:43 -0600 Subject: [PATCH 4/7] adding specified django settings for edx-notes-api --- lms/envs/common.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 5d63d07e2afc..4420e89d42c1 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -440,7 +440,8 @@ # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. # The bulk of the actual work in storing the notes is done 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 as well + # .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings + # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API # .. toggle_use_cases: open_edx # .. toggle_creation_date: None # .. toggle_tickets: None From 0b5de99ab4af529fba07c8bd76fad2f4e8ef935c Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Thu, 28 Jan 2021 14:09:33 -0600 Subject: [PATCH 5/7] change toggle_description --- lms/envs/common.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 4420e89d42c1..9704959c95b5 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -437,9 +437,9 @@ # .. toggle_name: FEATURES['ENABLE_EDXNOTES'] # .. toggle_implementation: SettingToggle # .. toggle_default: False - # .. toggle_description: The edxnotes app is responsible for displaying parts of the Notes UI to students in different parts - # of the LMS, as well as figuring out whether Notes is enabled for a particular situation. - # The bulk of the actual work in storing the notes is done by a separate service (see the edx-notes-api repo). + # .. 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 # .. toggle_use_cases: open_edx From 3434f3bfaabc4e3913cf91d3ba8a081d909f943f Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Thu, 28 Jan 2021 16:22:57 -0600 Subject: [PATCH 6/7] checking CI tests --- lms/envs/common.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 9704959c95b5..b569ff18239d 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -439,7 +439,7 @@ # .. 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) + # 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 # .. toggle_use_cases: open_edx From d686427ac2a42be788d34ea837f47c1ba8171ccd Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Fri, 29 Jan 2021 08:00:19 -0600 Subject: [PATCH 7/7] update PR comments --- cms/envs/common.py | 4 +--- lms/envs/common.py | 8 ++++---- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/cms/envs/common.py b/cms/envs/common.py index 99287b0c896a..f01c95b70dc5 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -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) diff --git a/lms/envs/common.py b/lms/envs/common.py index b569ff18239d..ee9ba5c9e766 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -433,7 +433,7 @@ # 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 @@ -441,10 +441,10 @@ # 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 + # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API. If you update this setting, also update in Studio. # .. toggle_use_cases: open_edx - # .. toggle_creation_date: None - # .. toggle_tickets: None + # .. 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)