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: add a feature flag to disable dates tab for all courses #34511

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Cup0fCoffee
Copy link
Contributor

@Cup0fCoffee Cup0fCoffee commented Apr 15, 2024

Description

This PR adds a feature flag that allows disabling dates tab for all courses.

Testing instructions

  1. Run the platform in a way that is convenient for you - tutor, devstack, etc.
  2. Checkout this PR
  3. Check that by default courses have dates tab (you might need to run ./manage.py cms backfill_course_tabs for them to appear, for example if running on devstack)
  4. Set the DISABLE_DATES_TAB flag to True.
  5. Validate that all courses now have the dates tab hidden, as it is no longer enabled.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

@openedx-webhooks
Copy link

openedx-webhooks commented Apr 15, 2024

Thanks for the pull request, @Cup0fCoffee!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. 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:

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 15, 2024
@Cup0fCoffee Cup0fCoffee force-pushed the maxim/bb-8271-hiding-dates-tab-for-all-courses branch from 44940e9 to cf0ff34 Compare April 15, 2024 19:59
@Cup0fCoffee Cup0fCoffee force-pushed the maxim/bb-8271-hiding-dates-tab-for-all-courses branch from cf0ff34 to 426ca05 Compare April 15, 2024 20:08
@Cup0fCoffee Cup0fCoffee force-pushed the maxim/bb-8271-hiding-dates-tab-for-all-courses branch from 426ca05 to 88bb2a4 Compare April 16, 2024 08:14
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2024-04-15
# .. toggle_tickets: https://github.com/openedx/edx-platform/pull/34511
'DISABLE_DATES_TAB': False,
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of an instance-wide setting, I think it makes more sense to make this configurable per course, by setting is_hideable = True in the DatesTab class, and creating a course app to configure it in case the pages and resources MFE is enabled (e.g.

def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool:
).

Copy link
Contributor

@ArturGaspar ArturGaspar 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: setting the feature flag hides the dates tab when it is otherwise shown
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository. - N/A

@farhaanbukhsh
Copy link
Member

@mphilbrick211 does this require a product review as well?

@farhaanbukhsh
Copy link
Member

@itsjeyd same question as above?

@itsjeyd
Copy link
Contributor

itsjeyd commented May 23, 2024

@farhaanbukhsh Please have a look at Does my contribution require Product Review?, it should help you with answering your question :)

@farhaanbukhsh
Copy link
Member

@mphilbrick211 @itsjeyd it does qualify for product review. :)

@itsjeyd itsjeyd added the product review PR requires product review before merging label May 27, 2024
@itsjeyd
Copy link
Contributor

itsjeyd commented May 27, 2024

@farhaanbukhsh Alright, thanks for checking. The next step will be for you to complete the first two items listed here to get the product review process going.

CC @mphilbrick211

@farhaanbukhsh
Copy link
Member

@Cup0fCoffee @mphilbrick211 @itsjeyd I have made a proposal openedx/platform-roadmap#392

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 product review PR requires product review before merging
Projects
Status: Product Review
Development

Successfully merging this pull request may close these issues.

5 participants