feat: add docs for Typesense search backend (FC-0091)

[samuelallan72]

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:

• https://github.com/open-craft/tutor-contrib-typesense
• feat: add Typesense backend for search (FC-0091) forum#225
• Typesense Backend [FC-0091] edx-search#222

Private-ref: https://tasks.opencraft.com/browse/BB-10458

Testing instructions

• view the rendered page from CI at: https://docsopenedxorg--1376.org.readthedocs.build/en/1376/site_ops/how-tos/use_typesense_search_backend.html
• verify everything is rendered correctly
• verify the information is accurate (cross reference with the above linked PRs and tutor plugin)
• verify the information is readable

[openedx-webhooks]

Thanks for the pull request, @samuelallan72!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

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

Details

---

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[bradenmacdonald]

Looks great! Just one suggestion.

[bradenmacdonald]

Should we start with some context about what Typesense is, and why someone might want to use it? (Because you want a HA search engine, and the default one - Meili - is not).

[samuelallan72]

Good idea, I've done some rewording. Hopefully it's better now. :)

[sarina]

Is it going to be available in Verawood? Given that we often forget to come back to docs, it would be good to indicate an anticipated timeline, and/or explain where to keep track of release status (forums? github issue?)

[bradenmacdonald]

Yeah, we can say it will be available in Verawood.

[samuelallan72]

Updated, thanks!

[sarina]

We added these as blank tables to all existing docs because we had no record of when they were last written/reviewed. If these instructions work as of now, I would put your name (or WG affiliation) and indicate that as of today, the instructions work.

[samuelallan72]

Ah got it, I have been wondering about the process behind these review tables.

I've done that, not that I've comprehensively tested these instructions as-is (they are compiled from the tutor-contrib-typesense docs and my notes from previous testing).