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: integrate openedx search api with existing CoursewareSearch.jsx #1433

Closed

Conversation

qasimgulzar
Copy link

@qasimgulzar qasimgulzar commented Aug 8, 2024

Under this PR I have used openedx-search-api to enable courseware search feature.

Screen.Recording.2024-08-08.at.11.23.33.PM.mov

@openedx-webhooks
Copy link

Thanks for the pull request, @qasimgulzar!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

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

Who will review my changes?

This repository is currently maintained by @openedx/committers-frontend-app-learning. 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 Aug 8, 2024
@bradenmacdonald
Copy link
Contributor

@qasimgulzar Please provide full, detailed instructions for how to test this, including links to all other required PRs and configuration settings.

Personally, I would also really like to see what it looks like when the studio search (in course-authoring) is converted to use this, as it's a far more complex use case than the very simple course search UX here.

@qasimgulzar
Copy link
Author

Added location information to index
image

@itsjeyd itsjeyd added the product review PR requires product review before merging label Sep 7, 2024
@itsjeyd
Copy link

itsjeyd commented Sep 7, 2024

OSPR management note: Product review in progress via openedx/platform-roadmap#378.

Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

For new code like this, I would strongly prefer we load the search engine config and results using React Query like this rather than using Redux. See OEP-67.

@@ -7,5 +7,6 @@ config.resolve.alias = {
...config.resolve.alias,
'@src': path.resolve(__dirname, 'src'),
};
config.externalsType = 'script';
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this for?

@regisb
Copy link

regisb commented Oct 4, 2024

Note to self: to test this PR, we have to enable the courseware.mfe_courseware_search waffle flag.

@itsjeyd itsjeyd added the blocked by other work PR cannot be finished until other work is complete label Oct 11, 2024
@itsjeyd
Copy link

itsjeyd commented Oct 11, 2024

OSPR management note: Marking this as blocked based on this update from @ormsbee over on the product proposal ticket.

@itsjeyd
Copy link

itsjeyd commented Oct 17, 2024

Hey @qasimgulzar, could you please check if this PR is still needed now that @regisb created another PR (openedx/edx-platform#35650) for addressing openedx/platform-roadmap#378?

@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Oct 17, 2024
@regisb
Copy link

regisb commented Oct 17, 2024

Let's close this PR for the moment. The interface that it proposes is different from my PR openedx/edx-platform#35650 because it connects to Meilisearch directly, but we can always re-open it in the future if we decide that we want to go with this approach.

@regisb regisb closed this Oct 17, 2024
@itsjeyd
Copy link

itsjeyd commented Oct 24, 2024

Thanks @regisb!

@itsjeyd itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked by other work PR cannot be finished until other work is complete open-source-contribution PR author is not from Axim or 2U product review PR requires product review before merging
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants