openedx
feat: legacy course navigation
Description
Add an option to enable the legacy course navigation where clicking a breadcrumb leads to the course index page highlighting the selected section.
Testing instructions
- Set ENABLE_LEGACY_NAV='true' and ENABLE_JUMPNAV='false'
- Open a course unit
- Click the breadcrumb navigation
- See that you are redirected to the course index page and that the item corresponding to the selected breadcrumb is highlighted and scrolled to
Thanks for the pull request, @ArturGaspar!
What's next?
Please work through the following steps to get your changes ready for engineering review:
:radio_button: Get product approval
If you haven't already, check this list to see if your contribution needs to go through the product review process.
- If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
- If it doesn't, simply proceed with the next step.
:radio_button: Provide context
To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
- Dependencies
This PR must be merged before / after / at the same time as ...
- Blockers
This PR is waiting for OEP-1234 to be accepted.
- Timeline information
This PR must be merged by XX date because ...
- Partner information
This is for a course on edx.org.
- Supporting documentation
- Relevant Open edX discussion forum threads
:radio_button: Get a green build
If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.
:radio_button: Update the status of your PR
Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.
:radio_button: Let us know that your PR is ready for review:
Who will review my changes?
This repository is currently maintained by @openedx/committers-frontend-app-learning. Tag them in a comment and let them know that your changes are ready for review.
Where can I find more information?
If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
- Overview of Review Process for Community Contributions
- Pull Request Status Guide
- Making changes to your pull request
When can I expect my changes to be merged?
Our goal is to get community contributions seen and reviewed as efficiently as possible.
However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
- The size and impact of the changes that it introduces
- The need for product review
- Maintenance status of the parent repository
:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.
@ArturGaspar Thank you for this contribution! Please let me know when internal review is done and the build is green.
@jmakowski1123 This is a user-facing change so we'll most likely need a feature ticket for it. Could you please confirm?
CC @mphilbrick211
@ArturGaspar, this needs to pass through the client's UX QA first, so we can convert the PR to a draft for now.
cc: @itsjeyd
Codecov Report
Attention: Patch coverage is 96.15385% with 1 line in your changes missing coverage. Please review.
Project coverage is 87.96%. Comparing base (
bce25c4) to head (2a6b218). Report is 219 commits behind head on master.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| src/index.jsx | 0.00% | 1 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## master #1239 +/- ##
==========================================
+ Coverage 87.30% 87.96% +0.65%
==========================================
Files 275 277 +2
Lines 4717 4743 +26
Branches 1190 1199 +9
==========================================
+ Hits 4118 4172 +54
+ Misses 580 555 -25
+ Partials 19 16 -3
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
@ArturGaspar, please mark this PR as ready for review.
I left one review comment on the backport PR (https://github.com/open-craft/frontend-app-learning/pull/6#discussion_r1420906605) instead of this one. I'm mentioning this for the full context
There is a larger project in play now to bring back the sidebar navigation experience, which was the original experience that was replaced by the breadcrumbs. Part of the consideration in that project is how many navigation options we need, and the breadcrumb pathway is being reconsidered in that context. We need to come to a decision first about which navigation experience the core product supports as the primary one, before investing in this. Suggest to put this on temporarily on hold. https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3909779457/Feature+Enhancement+Proposal+Restore+the+left-sidebar+navigation+in+the+learner+experience
@jmakowski1123, the project you mentioned sounds like a significant change. Do you know if there is any timeline for making this decision?
This PR brings back the legacy (non-MFE) experience - it only changes the action triggered by clicking on the text in the course navigation. If we decide to delete the breadcrumbs, the scope of that project won't be altered in any way by this change.
In the meantime, this PR gives us a (rather nice) side effect of highlighting specific parts of the Course Outline when redirecting users from external pages. Let's say we add a link like LMS_URL/course/{course_name}#{block_id} to the external page. When users click on it, they will be directed to the Course Outline page with the highlighted block_id (section/subsection), as shown on the screenshots. This is especially useful for the mobile experience, as the page is automatically scrolled to the highlighted element of the Course Outline.
cc: @itsjeyd
@jmakowski1123, the project you mentioned sounds like a significant change. Do you know if there is any timeline for making this decision?
This PR brings back the legacy (non-MFE) experience - it only changes the action triggered by clicking on the text in the course navigation. If we decide to delete the breadcrumbs, the scope of that project won't be altered in any way by this change. In the meantime, this PR gives us a (rather nice) side effect of highlighting specific parts of the Course Outline when redirecting users from external pages. Let's say we add a link like
LMS_URL/course/{course_name}#{block_id}to the external page. When users click on it, they will be directed to the Course Outline page with the highlightedblock_id(section/subsection), as shown on the screenshots. This is especially useful for the mobile experience, as the page is automatically scrolled to the highlighted element of the Course Outline.cc: @itsjeyd
I'd like to push for agreement/decision by the end of Jan, with the goal of beginning implementation in Feb for hopeful inclusion in Redwood. You can follow, and join, the conversation here, please feel free to join the wiki thread: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3909779457/Feature+Enhancement+Proposal+Restore+the+left-sidebar+navigation+in+the+learner+experience
I'd like to push for agreement/decision by the end of Jan, with the goal of beginning implementation in Feb for hopeful inclusion in Redwood. You can follow, and join, the conversation here, please feel free to join the wiki thread: openedx.atlassian.net/wiki/spaces/OEPM/pages/3909779457/Feature+Enhancement+Proposal+Restore+the+left-sidebar+navigation+in+the+learner+experience
Hey @jmakowski1123, based on a brief look at the wiki thread it seems like product review is still in progress. Do you have any updates about the timeline for this work?
CC @Agrendalath @ArturGaspar
Hey @cassiezamparini, would you have time to help get the ball rolling again here in terms of product review?
@itsjeyd Sure thing! I'll add this to my to-do list for tomorrow :)
@itsjeyd It looks like this feature is on hold based on the comments from @jmakowski1123 in this thread. But I see you linked to my comment on the sidebar query. I'll follow up on this on the Wiki.
Also in order to do a product review, we need to follow the new process @ArturGaspar @Agrendalath - as outlined here. Please review the link above and follow the steps I mention below:
- [ ] Create product proposal using a Template: Choose Your Template - Open Source Product Contributions
- [ ] Create a Product Proposal ticket in the platform-roadmap GitHub repository (with a link to the product proposal etc). Note, tickets must be created here. The ticket will get auto-added to the Open edX Roadmap project board: Open edX Roadmap • openedx
- [ ] The Submitter pings the Core Product Working Group in Slack (#wg-product-core) and shares the proposal. You can ping me once you've created the proposal and I can ping the Core Product WG on your behalf.
Please let me know if anything is unclear. We are still in the process of ironing out this new product review process, so your feedback will be welcomed.
@itsjeyd @Agrendalath @ArturGaspar
In relation to Feature Enhancement Proposal: Restore the left-sidebar navigation in the learner experience:
Edward Zarecor: Yes, the design phase has wrapped up and dev phase is starting now. It's targeted for GA in Redwood.
Thoughts?
@cassiezamparini Thanks for looking into the status of product review for this PR!
Edward Zarecor: Yes, the design phase has wrapped up and dev phase is starting now. It's targeted for GA in Redwood.
Thoughts?
I don't know what GA means, and I'm not sure how to proceed from here.
If the dev phase is starting now, does that mean we can consider this PR approved from the product perspective?
--
Either way, it's probably worth noting that my involvement here is limited to OSPR management (which currently doesn't include tracking individual steps of the product review process) 🙂
From that perspective, the main question to answer is the one above, i.e. whether product review is done and we can move forward with finding engineering reviewers for this PR.
--
CC @ArturGaspar @Agrendalath @e0d
As part of the project to reimplement the left sidebar navigation (full MVP spec here), I do not think it is necessary to invest in any legacy navigation experiences. The project to reimplement the left sidebar nav is a separate project from this proposal, and I think it will be possible to close this proposal as a result of the other project.
I'm assuming the point of proposing to revive the legacy breadcrumb experience is to make it easier for learners to see where they are in the course outline? This problem will be solved when we reimplement the left sidebar, as learners will be able to wayfind through the course outline without leaving the content.
The left sidebar will be revived for the Redwood release in June and will be the default experience out of the box. @ArturGaspar does this meet your needs, and if so, can we close this proposal?
@jmakowski1123 It is possible that the sidebar navigation would fulfil our needs, so I am converting this PR to a draft until the released version can be evaluated. Thank you.
Hey @ArturGaspar and @Agrendalath, just checking in:
It is possible that the sidebar navigation would fulfil our needs, so I am converting this PR to a draft until the released version can be evaluated.
Do you have any updates on when this evaluation would happen?
@itsjeyd, it's in progress. We should have more info within the next two months.
cc: @ArturGaspar
@itsjeyd, we haven't gotten a clear decision about this yet. It may take another month or two.