docs: fix minor typos in the meilisearch feature configuration #34838
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @bradenmacdonald! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
There was a problem hiding this comment.
Hi @bradenmacdonald , these changes look good. Left one comment inline, but it's not a blocker to merging.
👍
-
I tested this - I read through the code
-
I checked for accessibility issuesN/A - Updates documentation
-
User-facing strings are extracted for translationN/A
|
|
||
| # Enable Studio search features (powered by Meilisearch) (beta, off by default) | ||
| MEILISEARCH_ENABLED = False | ||
| # Meilisearch URL that the python backend can use. Often points to another docker container or k8s service. | ||
| MEILISEARCH_URL = "http://meilisearch" | ||
| # URL that browsers (end users) can user to reach Meilisearch. Should be HTTPS in production. | ||
| # URL that browsers (end users) can use to reach Meilisearch. Should be HTTPS in production. | ||
| MEILISEARCH_PUBLIC_URL = "http://meilisearch.example.com" | ||
| # To support multi-tenancy, you can prefix all indexes with a common key like "sandbox7-" | ||
| # and use a restricted tenant token in place of an API key, so that this Open edX instance |
There was a problem hiding this comment.
nit: Is it worth mentioning that we already support using this MEILISEARCH_INDEX_PREFIX for multitenancy? This comment makes it sound like you have to do something more than just set this variable.
There was a problem hiding this comment.
If you're not using Tutor, you do have to do more than just set this variable. Only our tutor plugin takes care of the details for you.
|
@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
No code changes; just fix a typos and inconsistency in the comments related to the "Studio Search (beta)" feature.