Skip to content

fix: hide unavailable sequence title in course breadcrumbs [BB-4305] - #28028

Merged
davidjoy merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/bb-4305_hide_unavailable_sequence_title_in_course_breadcrumbs
Jul 22, 2021
Merged

fix: hide unavailable sequence title in course breadcrumbs [BB-4305]#28028
davidjoy merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/bb-4305_hide_unavailable_sequence_title_in_course_breadcrumbs

Conversation

@Agrendalath

@Agrendalath Agrendalath commented Jun 24, 2021

Copy link
Copy Markdown
Member

Description

When a sequence title is unavailable for a user (e.g. before starting a timed exam), the None value is displayed in course breadcrumbs. This hides it in such cases and ensures that a trailing breadcrumb separator is not displayed.

image

This replaces #27900.

Jira

OSPR-5882

Sandbox

https://pr28028.sandbox.opencraft.hosting/

Note: the course navigation does not work properly in the legacy frontend, but it's an issue related to the master branch. Setting courseware.use_legacy_frontend didn't resolve this, so we've included a direct link to the exam in testing instructions.

Testing instructions

  1. Go to this page.
  2. Log in as audit.
  3. Check that the empty unit name is hidden.

Manual testing instructions

  1. Add the following to envs/private.py:
    from .common import FEATURES
    FEATURES['ENABLE_SPECIAL_EXAMS'] = True
  2. Go to the LMS shell and run paver compile_sass.
  3. Set a subsection as a timed exam in Studio (Subsection -> Advanced -> Timed).
  4. Log in as honor (or another non-staff user).
  5. Go to the exam in LMS and check that None is no longer visible.

Deadline

None.

Reviewers

Settings

EDXAPP_FEATURES_EXTRA:
  ENABLE_SPECIAL_EXAMS: true

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @Agrendalath! I've created OSPR-5882 to keep track of it in JIRA, where we prioritize reviews. 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:

  • 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 needs triage open-source-contribution PR author is not from Axim or 2U labels Jun 24, 2021
@edx-status-bot

Copy link
Copy Markdown

Your PR has finished running tests. There were no failures.

@shimulch shimulch left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@Agrendalath Thanks for fixing this. LGTM 👍

  • I tested this on my local devstack. Reproduced the issue and verified that this PR resolves it.
  • I read through the code
  • [N/A] I checked for accessibility issues
  • Includes documentation
  • [N/A] I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

@Agrendalath

Copy link
Copy Markdown
Member Author

@natabene, this is ready for your review.

@natabene

Copy link
Copy Markdown
Contributor

@Agrendalath Thank you for your contribution.

@davidjoy
davidjoy merged commit a5d9dd4 into openedx:master Jul 22, 2021
@openedx-webhooks

Copy link
Copy Markdown

@Agrendalath 🎉 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

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

@Agrendalath
Agrendalath deleted the agrendalath/bb-4305_hide_unavailable_sequence_title_in_course_breadcrumbs branch July 23, 2021 16:30
Agrendalath added a commit to open-craft/openedx-platform that referenced this pull request Nov 25, 2021
…8028)

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.

(cherry picked from commit a5d9dd4)
Agrendalath added a commit to open-craft/openedx-platform that referenced this pull request Jan 20, 2022
…8028)

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.

(cherry picked from commit a5d9dd4)
Agrendalath added a commit to open-craft/openedx-platform that referenced this pull request May 12, 2022
…8028)

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.

(cherry picked from commit a5d9dd4)
Agrendalath added a commit to open-craft/openedx-platform that referenced this pull request Jun 7, 2022
…8028)

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.

(cherry picked from commit a5d9dd4)
Agrendalath added a commit to open-craft/openedx-platform that referenced this pull request Jun 7, 2022
…8028)

When a sequence title was unavailable for a user (e.g. before starting a timed
exam), the `None` value was displayed in course breadcrumbs. This hides it in
such cases and ensures that a trailing breadcrumb separator is not displayed.

(cherry picked from commit a5d9dd4)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merged open-source-contribution PR author is not from Axim or 2U

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants