ocaml / ocaml/infrastructure

Search server

Open
#38 6 comments 1 reaction 1 assignee View on GitHub

@art-w is already working on this.

Since May 16, 2023.

Dominant language
HTML
Stars
42
Forks
11
PR merge metrics
No merged PRs in 30d

Description

@sabine has a pending PR to add search to ocaml.org in packages documentation https://github.com/ocaml/ocaml.org/pull/1096 using sherlodoc

This search uses the http rest api at https://doc.sherlocode.com which lies outside the ocaml infrastructure. We would like to deploy the sherlodoc executable closer to ocaml.org to avoid depending on an external service.

The main issue is the ~9go database file that needs to be accessible (otherwise we could just run the sherlodoc executable from the ocaml.org container) We aren't there yet, but we are planning to run the database creation as part of voodoo to keep it up to date. In the mean time, it would be nice if the search UI could be made accessible, for users benefit, to gather their feedback and improve upon in parallel...

Do you have some advice on how to proceed? :)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.