feat: add share link button when hide from toc is enabled in sections #34043

BryanttV · 2024-01-12T00:39:31Z

Description

This PR adds a new button in the child subsections of sections with Hide From TOC enabled. This button displays a new modal with two tabs. The first tab displays a button that allows you to copy the link of that subsection to the clipboard. The second tab displays a button that allows you to copy the embedded link of the same subsection to the clipboard.

In this way, instructors will be able to pass the link to their students so that they can access the subsections that are hidden from the interface.

Supporting information

These changes are part of the effort made to implement Feature Enhancement Proposal: Hide Sections from Course Outline

Dependencies

Important

This PR needs the changes made from this PR, which includes the new section visibility option from Studio UI.

Testing instructions

In your environment add a mount of edx-platform with tutor mounts add <path/to/edx-platform>
Move into this branch with git checkout bav/add-share-link-button
Get the changes from this PR with git rebase MJG/configurable-hide-from-toc and resolves conflicts by accepting both changes.
Add this setting in your environment: FEATURES["ENABLE_HIDE_FROM_TOC_UI"] = True
Run tutor dev exec lms openedx-assets build --env=dev to regenerate the assets.
Create your course with sections and subsections.
In the section settings (⚙️) go to the Visibility tab > ☑️ Hide in Course Outline, accessible via Link
Now, you should see a button to share the link in the child subsections of that section.
Press the button and see the new modal.
Navigate between the tabs and copy the subsection link, either full page or embedded.

hft-share-link-demo.mp4

Deadline

This effort is part of the Spanish consortium project, so it'd be ideal to merge this before the end of the project.

openedx-webhooks · 2024-01-12T00:39:37Z

Thanks for the pull request, @BryanttV! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

cms/djangoapps/contentstore/xblock_storage_handlers/view_handlers.py

cms/static/js/views/modals/course_outline_modals.js

cms/static/js/views/xblock_outline.js

cms/templates/js/course-outline.underscore

cms/templates/js/embed-link-share-link-editor.underscore

cms/templates/js/full-page-share-link-editor.underscore

cms/static/js/views/modals/course_outline_modals.js

cms/static/sass/elements/_modal-window.scss

cms/static/js/views/modals/course_outline_modals.js

cms/templates/js/embed-link-share-link-editor.underscore

cms/templates/js/full-page-share-link-editor.underscore

mariajgrimaldi

This is working as expected! Thank you.

You have to address one last comment I left. Thanks again!

This PR is still a WIP

cms/templates/js/subsection-share-link-modal-tabs.underscore

cms/static/js/views/modals/course_outline_modals.js

johnvente · 2024-02-14T21:08:53Z

cms/static/js/views/modals/course_outline_modals.js

        render: function() {
            var xblockInfo = this.model;
            var isTimeLimited = xblockInfo.get('is_time_limited');
            var isProctoredExam = xblockInfo.get('is_proctored_exam');
            var isPracticeExam = xblockInfo.get('is_practice_exam');
            var isOnboardingExam = xblockInfo.get('is_onboarding_exam');
+            var enableHideFromTOCUI = xblockInfo.get('enable_hide_from_toc_ui');


This would be better with isEnableHideFromTOCUI but I understand you will have to change enable_hide_from_toc_ui to is_enable_hide_from_toc_ui so is just a minor suggestion

Yes, this field was included in the dependency PR. I'll leave the name as it is so as not to affect any other PR related to the functionality.

mariajgrimaldi

This is working as it was described in the cover letter. Thank you! I'll approve this PR, although it's blocked by #33952

Also, remember to address @johnvente's comments! Thank you

BryanttV · 2024-02-15T17:25:48Z

Hi @johnvente, I addressed your comments, can you check again? thanks!

johnvente

LGTM!

Adds a new button in the child subsections of sections with Hide From TOC enabled. This button displays a new modal with two tabs. The first tab displays a button that allows you to copy the link of that subsection to the clipboard. The second tab displays a button that allows you to copy the embedded link of the same subsection to the clipboard. Ref: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3853975595/Feature+Enhancement+Proposal+Hide+Sections+from+course+outline

openedx-webhooks · 2024-03-07T18:12:20Z

@BryanttV 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2024-03-07T19:23:11Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-03-07T19:43:31Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-03-07T19:43:31Z

2U Release Notice: This PR has been deployed to the edX production environment.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 12, 2024

BryanttV force-pushed the bav/add-share-link-button branch 4 times, most recently from 35b6496 to ffeb351 Compare January 12, 2024 17:24

mariajgrimaldi requested changes Jan 12, 2024

View reviewed changes

mariajgrimaldi reviewed Jan 12, 2024

View reviewed changes

cms/templates/js/embed-link-share-link-editor.underscore Outdated Show resolved Hide resolved

mariajgrimaldi reviewed Jan 12, 2024

View reviewed changes

cms/templates/js/full-page-share-link-editor.underscore Outdated Show resolved Hide resolved

johnvente reviewed Jan 12, 2024

View reviewed changes

cms/static/js/views/modals/course_outline_modals.js Show resolved Hide resolved

johnvente reviewed Jan 12, 2024

View reviewed changes

cms/static/sass/elements/_modal-window.scss Outdated Show resolved Hide resolved

BryanttV commented Jan 12, 2024

View reviewed changes

cms/static/js/views/modals/course_outline_modals.js Outdated Show resolved Hide resolved

johnvente reviewed Jan 12, 2024

View reviewed changes

cms/static/js/views/modals/course_outline_modals.js Show resolved Hide resolved

johnvente reviewed Jan 12, 2024

View reviewed changes

cms/static/js/views/modals/course_outline_modals.js Outdated Show resolved Hide resolved

BryanttV force-pushed the bav/add-share-link-button branch 3 times, most recently from 0d8ee55 to a2c07c2 Compare January 15, 2024 13:48

mariajgrimaldi reviewed Jan 15, 2024

View reviewed changes

cms/templates/js/embed-link-share-link-editor.underscore Outdated Show resolved Hide resolved

mariajgrimaldi reviewed Jan 15, 2024

View reviewed changes

cms/templates/js/full-page-share-link-editor.underscore Outdated Show resolved Hide resolved

mariajgrimaldi previously approved these changes Jan 15, 2024

View reviewed changes

BryanttV force-pushed the bav/add-share-link-button branch from 855a2db to bb606e6 Compare January 15, 2024 16:00

BryanttV marked this pull request as ready for review January 15, 2024 16:02

BryanttV force-pushed the bav/add-share-link-button branch 3 times, most recently from c64f1be to ed0e707 Compare January 16, 2024 14:17

BryanttV force-pushed the bav/add-share-link-button branch 4 times, most recently from 967fde4 to 9a97386 Compare February 14, 2024 17:33

BryanttV force-pushed the bav/add-share-link-button branch 5 times, most recently from fb794a4 to 3203030 Compare February 14, 2024 20:55

johnvente reviewed Feb 14, 2024

View reviewed changes

cms/templates/js/subsection-share-link-modal-tabs.underscore Outdated Show resolved Hide resolved

johnvente reviewed Feb 14, 2024

View reviewed changes

cms/static/js/views/modals/course_outline_modals.js Outdated Show resolved Hide resolved

johnvente reviewed Feb 14, 2024

View reviewed changes

mariajgrimaldi approved these changes Feb 15, 2024

View reviewed changes

johnvente approved these changes Feb 15, 2024

View reviewed changes

itsjeyd added the product review PR requires product review before merging label Feb 16, 2024

itsjeyd added the product review complete PR has gone through product review label Feb 23, 2024

BryanttV added 2 commits March 1, 2024 11:42

chore: address PR review

1742431

BryanttV force-pushed the bav/add-share-link-button branch from 3203030 to 1742431 Compare March 1, 2024 16:43

mariajgrimaldi merged commit 19bc5c8 into openedx:master Mar 7, 2024
47 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add share link button when hide from toc is enabled in sections #34043

feat: add share link button when hide from toc is enabled in sections #34043

BryanttV commented Jan 12, 2024 •

edited

Loading

openedx-webhooks commented Jan 12, 2024 •

edited

Loading

mariajgrimaldi left a comment

johnvente Feb 14, 2024 •

edited

Loading

BryanttV Feb 15, 2024

mariajgrimaldi left a comment

BryanttV commented Feb 15, 2024

johnvente left a comment

openedx-webhooks commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

feat: add share link button when hide from toc is enabled in sections #34043

feat: add share link button when hide from toc is enabled in sections #34043

Conversation

BryanttV commented Jan 12, 2024 • edited Loading

Description

Supporting information

Dependencies

Testing instructions

Deadline

openedx-webhooks commented Jan 12, 2024 • edited Loading

mariajgrimaldi left a comment

Choose a reason for hiding this comment

johnvente Feb 14, 2024 • edited Loading

Choose a reason for hiding this comment

BryanttV Feb 15, 2024

Choose a reason for hiding this comment

mariajgrimaldi left a comment

Choose a reason for hiding this comment

BryanttV commented Feb 15, 2024

johnvente left a comment

Choose a reason for hiding this comment

openedx-webhooks commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

edx-pipeline-bot commented Mar 7, 2024

BryanttV commented Jan 12, 2024 •

edited

Loading

openedx-webhooks commented Jan 12, 2024 •

edited

Loading

johnvente Feb 14, 2024 •

edited

Loading