feat: add docs for Typesense search backend (FC-0091) #1376
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @samuelallan72! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
samuelallan72
force-pushed
the
samuel/document-typesense-search
branch
from
062e051 to
1543ff0
Compare
bradenmacdonald
left a comment
bradenmacdonald
left a comment
There was a problem hiding this comment.
Looks great! Just one suggestion.
samuelallan72
changed the title
Document how to get started with the new Typesense search backend, and some tips about clustered Typesense and using a web dashboard. Private-ref: https://tasks.opencraft.com/browse/BB-10458
samuelallan72
force-pushed
the
samuel/document-typesense-search
branch
from
11326d6 to
7daffb1
Compare
|
Thanks! I've rebased on main and squashed the commits. :) |
Docs are being added to Open edX Documentation in openedx/docs.openedx.org#1376 , so that should be the source of truth.
github-project-automation
bot
moved this from Waiting on Author
to Done
in Contributions
Support searching forum threads and comments using Typesense as a backend. This is completely backwards compatible; Meilisearch can still be used as the backend with no changes, and existing installations will continue to be configured to use Meilisearch. The new backend can be enabled by setting: ```py TYPESENSE_ENABLED = True ``` You can also manually set the backend for testing with something like: ```py FORUM_SEARCH_BACKEND = "forum.search.typesense.TypesenseBackend" ``` Configuring the Typesense backend can be done with these settings: ```py TYPESENSE_API_KEY = "your-secret-api-key" TYPESENSE_URLS = ["https://typesense-1.example.com:8108", "https://typesense-2.example.com:8108"] ``` The actual implementation differs from the Meilisearch backend in some areas, mostly for internal efficiency. For example, a single index is used to cover both threads and comments, while Meilisearch uses two. It aims to produce comparable results for searches by end users though. Docs about this are being added to Open edX Documentation in openedx/docs.openedx.org#1376 , so that will be the source of truth. Private-ref: https://tasks.opencraft.com/browse/BB-9975
Support searching forum threads and comments using Typesense as a backend. This is completely backwards compatible; Meilisearch can still be used as the backend with no changes, and existing installations will continue to be configured to use Meilisearch. The new backend can be enabled by setting: ```py TYPESENSE_ENABLED = True ``` You can also manually set the backend for testing with something like: ```py FORUM_SEARCH_BACKEND = "forum.search.typesense.TypesenseBackend" ``` Configuring the Typesense backend can be done with these settings: ```py TYPESENSE_API_KEY = "your-secret-api-key" TYPESENSE_URLS = ["https://typesense-1.example.com:8108", "https://typesense-2.example.com:8108"] ``` The actual implementation differs from the Meilisearch backend in some areas, mostly for internal efficiency. For example, a single index is used to cover both threads and comments, while Meilisearch uses two. It aims to produce comparable results for searches by end users though. Docs about this are being added to Open edX Documentation in openedx/docs.openedx.org#1376 , so that will be the source of truth. Private-ref: https://tasks.opencraft.com/browse/BB-9975
5 participants
Description
Document how to get started with the new Typesense search backend, and some tips about clustered Typesense and using a web dashboard.
Supporting information
NOTE: the typesense search backend has not been merged yet, but it has been approved. Related work:
Private-ref: https://tasks.opencraft.com/browse/BB-10458
Testing instructions