Skip to content

feat: add publish status to library meilisearch index - #36031

Merged
ChrisChV merged 3 commits into
openedx:masterfrom
open-craft:dvz/filter-by-published
Feb 5, 2025
Merged

feat: add publish status to library meilisearch index#36031
ChrisChV merged 3 commits into
openedx:masterfrom
open-craft:dvz/filter-by-published

Conversation

@DanielVZ96

Copy link
Copy Markdown
Contributor

Description

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.

Supporting information

Testing instructions

  1. [If needed] Create a new library with new components in http://apps.local.openedx.io:2001/course-authoring/libraries
  2. With the tutor stack running execute the following command: tutor dev exec cms bash -c './manage.py cms reindex_studio --experimental '
  3. Navigate to http://localhost:7700/
  4. Assert that the publish_status of the documents matches their respective components:
    • Published when the component was published and not modified since
    • Modified when the component has been modified after being published
    • Never when the component has never been published

Deadline

ASAP

Other information

Private-Ref

@openedx-webhooks

openedx-webhooks commented Dec 13, 2024

Copy link
Copy Markdown

Thanks for the pull request, @DanielVZ96!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 13, 2024
Adds the publish status field to the libraries v2 meilisearch index in
order to support filtering by component publish status: published,
modified, never.

@pomegranited pomegranited left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is working great, but I'm not sure that we need it?
If we do keep it, we need one more test, so I'm happy to conditionally approve. 👍

  • I tested this using the test instructions for openedx/frontend-app-authoring#1570
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes some documentation
  • User-facing strings are extracted for translation N/A

Comment thread openedx/core/djangoapps/content/search/documents.py
Comment thread openedx/core/djangoapps/content/search/tests/test_documents.py

@pomegranited pomegranited left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

  • I tested this using the test instructions for openedx/frontend-app-authoring#1570
  • I read through the code
  • I checked for accessibility issues by using my keyboard to navigate N/A
  • Includes documentation -- code comments
  • User-facing strings are extracted for translation N/A

@ChrisChV
ChrisChV enabled auto-merge (squash) February 5, 2025 17:11
@ChrisChV
ChrisChV merged commit 182bfc4 into openedx:master Feb 5, 2025
@ChrisChV
ChrisChV deleted the dvz/filter-by-published branch February 5, 2025 17:30
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

DanielVZ96 added a commit to open-craft/openedx-platform that referenced this pull request Feb 11, 2025
…edx#36031)

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
jciasenza pushed a commit to jciasenza/edx-platform that referenced this pull request Feb 25, 2025
…edx#36031)

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
…edx#36031)

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
UsamaSadiq pushed a commit that referenced this pull request May 14, 2025
Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
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

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants