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: [FC-0056] courseware sidebar enhancement #1386

Merged

Conversation

ihor-romaniuk
Copy link
Contributor

@ihor-romaniuk ihor-romaniuk commented May 15, 2024

Settings

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

TUTOR_GROVE_WAFFLE_FLAGS:
  - name: courseware.enable_navigation_sidebar
    everyone: true

Description

This pull request adds several improvements to the courseware sidebar navigation.

  • Display section and sequence progress
  • Add tracking event to the unit button
  • Hide the horizontal unit navigation with enabled sidebar navigation

Related PRs

Depends on BE PRs

Design

https://www.figma.com/file/gew5tORDX4Q7wxOS8vjqZu/side-nav-OEX?type=design&node-id=318-3234&mode=design&t=rBe1ToNYP8RY6QOp-0

image

Testing instructions

  1. Run master devstack.
  2. Start platform make dev.up.lms+cms+frontend-app-course-authoring and make checkout on this branch.
  3. Go to Course Unit page from the Course Outline page.

@openedx-webhooks
Copy link

openedx-webhooks commented May 15, 2024

Thanks for the pull request, @ihor-romaniuk! 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 May 15, 2024
Copy link

codecov bot commented May 15, 2024

Codecov Report

Attention: Patch coverage is 82.69231% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 88.66%. Comparing base (257c9dc) to head (b13de55).
Report is 7 commits behind head on master.

Current head b13de55 differs from pull request most recent head d28f1bb

Please upload reports for the commit d28f1bb to get more accurate results.

Files Patch % Lines
...sidebars/course-outline/components/SidebarUnit.jsx 18.18% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1386      +/-   ##
==========================================
- Coverage   88.74%   88.66%   -0.09%     
==========================================
  Files         303      307       +4     
  Lines        5224     5266      +42     
  Branches     1330     1338       +8     
==========================================
+ Hits         4636     4669      +33     
- Misses        572      581       +9     
  Partials       16       16              

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

@ihor-romaniuk ihor-romaniuk marked this pull request as ready for review May 17, 2024 12:48
@ihor-romaniuk ihor-romaniuk added the create-sandbox open-craft-grove should create a sandbox environment from this PR label May 17, 2024
@open-craft-grove
Copy link

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

@ihor-romaniuk ihor-romaniuk force-pushed the romaniuk/outline-sidebar-enhancement branch from bb73f23 to b13de55 Compare May 22, 2024 13:34
@open-craft-grove
Copy link

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

@itsjeyd itsjeyd added product review PR requires product review before merging product review complete PR has gone through product review labels May 23, 2024
@itsjeyd
Copy link

itsjeyd commented May 23, 2024

Adding product review complete label here, based on #1342 (comment).

CC @crathbun428 @mphilbrick211 @GlugovGrGlib

@itsjeyd
Copy link

itsjeyd commented May 23, 2024

@ihor-romaniuk Thanks for these changes.

It looks like codecov is failing right now. Once that's sorted out we should be good to start engineering review.

EDIT: Actually, we might need to wait for openedx/edx-platform#34816 to get merged?

@itsjeyd itsjeyd added the blocked by other work PR cannot be finished until other work is complete label May 23, 2024
@GlugovGrGlib GlugovGrGlib removed the blocked by other work PR cannot be finished until other work is complete label May 24, 2024
@open-craft-grove
Copy link

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

- Display section and sequence progress
- Add tracking event to the unit button
- Hide the horizontal unit navigation with enabled sidebar navigation
@ihor-romaniuk ihor-romaniuk force-pushed the romaniuk/outline-sidebar-enhancement branch from b13de55 to d28f1bb Compare May 27, 2024 07:27
@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.

Looks great, works great! Thanks!

@arbrandes
Copy link

I'm rerunning tests before merging.

@arbrandes arbrandes merged commit 58c8ec5 into openedx:master May 30, 2024
4 of 5 checks passed
@openedx-webhooks
Copy link

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

@arbrandes
Copy link

Running into token issues for coverage. Let's deal with that separately.

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 complete PR has gone through product review product review PR requires product review before merging
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants