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

fix: breadcrumb and sidebar preview link #1660

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

KristinAoki
Copy link
Member

Description

This PR fixes the left sidebar navigation and breadcrumbs not having preview links when a staff user is viewing a course in "Preview" mode.

Supporting Information

GitHub Issue #1657

Testing

Breadcrumbs

  1. In Django Admin disable courseware.enable_navigation_sidebar
  2. Open a course in Studio
  3. Navigate to a unit
  4. Make a change to confirm that you are seeing a preview
  5. Click "Preview"
  6. Click on the section or subsection breadcrumb
  7. Confirm that the url includes /preview/
  8. Confirm that the draft version of the unit is still visible

Left sidebar navigation

  1. In Django Admin enable courseware.enable_navigation_sidebar
  2. Open a course in Studio
  3. Navigate to a unit
  4. Make a change to confirm that you are seeing a preview
  5. Click "Preview"
  6. Click on the highlighted unit
  7. Confirm that the url includes /preview/
  8. Confirm that the draft version of the unit is still visible

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 26, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @KristinAoki!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

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


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:

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

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Mar 26, 2025
@KristinAoki KristinAoki linked an issue Mar 26, 2025 that may be closed by this pull request
Copy link

codecov bot commented Mar 26, 2025

Codecov Report

Attention: Patch coverage is 91.42857% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.06%. Comparing base (d5a092b) to head (c1e3bca).

Files with missing lines Patch % Lines
...c/courseware/course/breadcrumbs/BreadcrumbItem.tsx 88.88% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1660      +/-   ##
==========================================
- Coverage   90.09%   90.06%   -0.04%     
==========================================
  Files         338      339       +1     
  Lines        5784     5795      +11     
  Branches     1370     1412      +42     
==========================================
+ Hits         5211     5219       +8     
- Misses        557      558       +1     
- Partials       16       18       +2     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@KristinAoki KristinAoki changed the title fix: breadcrumb sidebar preview link fix: breadcrumb and sidebar preview link Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

Sidbar has non-preview links in preview mode
2 participants