edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

feat: adds sortable fields to studio content search index [FC-0059]

Open pomegranited opened this issue 1 year ago • 1 comments

Description

This PR adds new datetime fields to the serialized library block metadata: created, modified, and last_published, and adds support for sorting search results by these dates or the block title/display_name.

This change should not impact any current users, as content libraries v2 are not yet ready for production use.

Supporting information

Part of https://github.com/openedx/frontend-app-course-authoring/issues/1038

Testing instructions

See https://github.com/openedx/frontend-app-course-authoring/pull/1147 for full testing instructions.

Deadline

ASAP -- to meet project deadlines

Other information

These changes can be deployed by running the management command:

python manage.py cms reindex_studio --experimental

pomegranited avatar Jul 09 '24 10:07 pomegranited

Thanks for the pull request, @pomegranited!

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: 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

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

openedx-webhooks avatar Jul 09 '24 10:07 openedx-webhooks

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks avatar Jul 25 '24 18:07 openedx-webhooks

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot avatar Jul 26 '24 07:07 edx-pipeline-bot

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot avatar Jul 26 '24 07:07 edx-pipeline-bot

@pomegranited I think one of the new tests might be flaky: https://github.com/openedx/frontend-app-course-authoring/actions/runs/10166343467/job/28116281335

Might need to wrap the failing line in a waitFor ?

bradenmacdonald avatar Jul 30 '24 17:07 bradenmacdonald