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: added meilisearch dependency and fixt index creation #4381

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

Conversation

qasimgulzar
Copy link

@qasimgulzar qasimgulzar commented Jul 5, 2024

Added django_meili into discovery to push data to meilisearch. below is a exmaple of command to push data

./manage.py syncindex course_metadata.ProgramProxy

Settings

################### Studio Search (beta), using Meilisearch ###################
MEILISEARCH_ENABLED = False
if MEILISEARCH_ENABLED:
    MEILISEARCH = {
        'HTTPS': False,  # Whether HTTPS is enabled for the meilisearch server
        'HOST': 'meilisearch',  # The host for the meilisearch server
        'MASTER_KEY': 'masterKey',
        # The master key for meilisearch. See https://www.meilisearch.com/docs/learn/security/basic_security for more detail
        'PORT': 7700,  # The port for the meilisearch server
        'TIMEOUT': None,  # The timeout to wait for when using sync meilisearch server
        'CLIENT_AGENTS': None,  # The client agents for the meilisearch server
        'DEBUG': DEBUG,  # Whether to throw exceptions on failed creation of documents
        'SYNC': False,
        # Whether to execute operations to meilisearch in a synchronous manner (waiting for each rather than letting the task queue operate)
        'OFFLINE': False,  # Whether to make any http requests for the application.
    }

@openedx-webhooks
Copy link

openedx-webhooks commented Jul 5, 2024

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.

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

Who will review my changes?

This repository is currently maintained by @openedx/course-discovery-admins. 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 Jul 5, 2024
@qasimgulzar qasimgulzar force-pushed the qasim/add-meilisearch-dependency branch from 4311b13 to d0f247d Compare July 5, 2024 12:40
Copy link

@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.

@qasimgulzar Can you please update this PR to provide more details? I don't understand how this works, what it's for, or how to test it. Does this allow replacing ElasticSearch with Meilisearch or is this just sending some data to a Meilisearch index, but not using that data?

'HTTPS': False, # Whether HTTPS is enabled for the meilisearch server
'HOST': 'meilisearch', # The host for the meilisearch server
'MASTER_KEY': 'masterKey',
# The master key for meilisearch. See https://www.meilisearch.com/docs/learn/security/basic_security for more detail

Choose a reason for hiding this comment

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

I don't think we should recommend using the master key for this sort of thing.

@mphilbrick211
Copy link

HI @qasimgulzar! Is this pull request still in progress?

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
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

4 participants