Skip to content

Conversation

@andrii-hantkovskyi
Copy link
Contributor

@andrii-hantkovskyi andrii-hantkovskyi commented Jun 3, 2025

Add Index Page Config API

This PR introduces a new API endpoint to provide dynamic configuration for the Catalog index page:

  • IndexPageConfigView: A Django REST Framework view at /branding/index that returns a JSON payload of configuration settings.
  • Settings are resolved using configuration_helpers.get_value() with support for SiteConfiguration overrides and fallbacks to Django settings.

The following keys are returned:

  • enable_course_sorting_by_start_date
  • homepage_overlay_html
  • show_partners
  • show_homepage_promo_video
  • homepage_course_max
  • homepage_promo_video_youtube_id

Unit tests verify fallback behavior, site-specific overrides, and expected default values for all fields.

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

openedx-webhooks commented Jun 3, 2025

Thanks for the pull request, @andrii-hantkovskyi!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

Details
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 Jun 3, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 3, 2025
@andrii-hantkovskyi andrii-hantkovskyi self-assigned this Jun 11, 2025
@andrii-hantkovskyi andrii-hantkovskyi marked this pull request as ready for review June 11, 2025 17:23
@andrii-hantkovskyi andrii-hantkovskyi requested a review from a team as a code owner June 11, 2025 17:23
@andrii-hantkovskyi
Copy link
Contributor Author

andrii-hantkovskyi commented Jun 11, 2025

Hi @diana-villalvazo-wgu, would you have a chance to review this PR when you have a moment?

@andrii-hantkovskyi andrii-hantkovskyi requested review from diana-villalvazo-wgu and removed request for kdmccormick June 11, 2025 17:41
@brian-smith-tcril
Copy link
Contributor

Could you provide context as to why the new MFE would need each of these?

I would think that most of this could be handled via plugin slots instead.

@andrii-hantkovskyi andrii-hantkovskyi changed the title feat: implement index page config api feat: [FC-86] implement index page config api Jun 18, 2025
* feat: rework config endpoint to use for different lms pages
@cmltaWt0
Copy link
Contributor

cmltaWt0 commented Aug 7, 2025

Closing this due to changed implementation.

@cmltaWt0 cmltaWt0 closed this Aug 7, 2025
@github-project-automation github-project-automation bot moved this from Waiting on Author to Done in Contributions Aug 7, 2025
@PKulkoRaccoonGang
Copy link
Contributor

Reopened at #37130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants