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

feat: show message in course outline when hide from toc is enabled #1262

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

BryanttV
Copy link
Contributor

@BryanttV BryanttV commented Dec 28, 2023

EDX_PLATFORM_REPOSITORY: https://github.com/openedx/edx-platform.git
EDX_PLATFORM_VERSION: master

TUTOR_GROVE_CMS_ENV_FEATURES: |
  ENABLE_HIDE_FROM_TOC_UI: True

Description

This PR adds messages in the course outline when the hide from toc is enabled from the sections (this functionality is added in this PR). From now on, from the hidden sections and their children (subsections), a message will be displayed only to the instructor indicating that these blocks are hidden from learners.

Screenshots

image

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.
  • This PR, which expose hide_from_toc field in course blocks.

Testing Instructions

Using tutor you can test these changes:

  1. Use a mount of edx-platform in a branch with the abovementioned changes.
  2. In the root of your tutor environment clone this repository.
  3. Create a mount with tutor mounts add frontend-app-learning
  4. Go to the frontend-app-learning folder and run npm install
  5. Run tutor config save and tutor dev start -d
  6. Go to Studio and create a new section and subsections.
  7. Hidden the section from ⚙️ > Visibility > Hide in Course Outline, accessible via Link
  8. As instructor, in the LMS go to the course home and see the new messages.

@openedx-webhooks
Copy link

openedx-webhooks commented Dec 28, 2023

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 28, 2023
@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 6bfb2b9 to 020538f Compare December 29, 2023 03:38
@BryanttV BryanttV changed the title feat: show hide from toc feat: show message in course outline when hide from toc is enabled Dec 29, 2023
@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 020538f to 6c15716 Compare December 29, 2023 03:58
Copy link

codecov bot commented Dec 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.38%. Comparing base (a91ef11) to head (ff13651).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1262   +/-   ##
=======================================
  Coverage   88.38%   88.38%           
=======================================
  Files         291      291           
  Lines        4949     4951    +2     
  Branches     1251     1253    +2     
=======================================
+ Hits         4374     4376    +2     
  Misses        561      561           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 44a2aee to 99da5b8 Compare January 2, 2024 15:35
@BryanttV BryanttV requested a review from johnvente January 4, 2024 22:13
@BryanttV BryanttV marked this pull request as ready for review January 4, 2024 22:13
@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch 2 times, most recently from 980ae58 to 4acc84e Compare January 5, 2024 15:06
@itsjeyd
Copy link

itsjeyd commented Jan 12, 2024

@BryanttV Thank you for this contribution! Please let us know when the build is green and the changes are ready for review.

@itsjeyd itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. blocked by other work PR cannot be finished until other work is complete product review PR requires product review before merging labels Jan 12, 2024
@itsjeyd
Copy link

itsjeyd commented Jan 12, 2024

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

Hi @jmakowski1123, since this PR is for an existing feature enhancement proposal, I'm flagging it for product review.

I'll cross-link from the roadmap ticket (openedx/platform-roadmap#301) shortly, too.

@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 0ef2825 to 895b8a9 Compare January 23, 2024 16:32
@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Jan 25, 2024
@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 895b8a9 to b5e2772 Compare January 30, 2024 18:29
@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from b5e2772 to 1ba0b4f Compare February 12, 2024 21:22
@mariajgrimaldi mariajgrimaldi self-requested a review February 12, 2024 22:49
Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this in my local environment, and it's working as described in the cover letter. Thank you!

@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 1ba0b4f to 5f5c7e2 Compare February 13, 2024 15:38
Copy link

@johnvente johnvente left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All my comments were addressed, LGTM!

@BryanttV BryanttV force-pushed the bav/show-hide-from-toc branch from 5f5c7e2 to ff13651 Compare March 1, 2024 17:33
@mariajgrimaldi
Copy link
Member

Hello there, @itsjeyd; this PR is also waiting for a maintainer review. Let me know if there's anything else we could do.

@arbrandes arbrandes self-requested a review March 1, 2024 19:24
@arbrandes arbrandes added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Mar 5, 2024
@arbrandes
Copy link

Fired off a sandbox. Let's see how it goes.

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

Copy link

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code works and looks good. Approved!

@arbrandes arbrandes merged commit 7c8e26d into openedx:master Mar 6, 2024
7 checks passed
@openedx-webhooks
Copy link

@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.

@itsjeyd itsjeyd removed the blocked by other work PR cannot be finished until other work is complete label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR open-source-contribution PR author is not from Axim or 2U product review PR requires product review before merging
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants