-
Notifications
You must be signed in to change notification settings - Fork 78
feat: add docs for Typesense search backend (FC-0091) #1376
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
base: main
Are you sure you want to change the base?
feat: add docs for Typesense search backend (FC-0091) #1376
Conversation
|
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. |
062e051 to
1543ff0
Compare
bradenmacdonald
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Just one suggestion.
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
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.
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