-
Notifications
You must be signed in to change notification settings - Fork 292
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
Integrate Sherlodoc search directly via the Sherlodoc API #1096
Conversation
Wot wot! 🎉 This is great! I do have one concern though: I'd strongly prefer that we don't rely on external services outside the control of the OCaml.org team. Can we deploy sherlocode on the ocamlorg infrastructure? |
We will when this has settled as the long-term solution. Would it be okay to deploy this in a "building-in-public"-fashion so we can get early feedbacks from users? I can also put it on staging if we want to be a bit more conservative wrt external calls on ocaml.org. ETA: or I can try and add sherlodoc to ocaml.org's Docker container. |
For sherlocode to be used in ocaml.org, it'd have to fall under the OCaml.org projects governance (c.f. https://ocaml.org/policies/governance), so move to an official org and be deployed as part of the OCaml infrastructure. I don't have concerns deploying it in staging to facilitate user research though! |
Yes that makes sense!
|
0d73584
to
5cc7a8f
Compare
With the work on adding search support in odoc, powered by sherlodoc, I suspect the plan has changed quite significantly. |
This patch that makes Sherlodoc search available on the package documentation.
Calls the Sherlodoc API directly from the browser.
Current limitation: Sherlodoc has one version of every package indexed and that's the version being searched.