Skip to content
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

Closed
wants to merge 7 commits into from

Conversation

sabine
Copy link
Collaborator

@sabine sabine commented Apr 14, 2023

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.

@tmattio
Copy link
Collaborator

tmattio commented Apr 14, 2023

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?

@sabine
Copy link
Collaborator Author

sabine commented Apr 14, 2023

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.

@tmattio
Copy link
Collaborator

tmattio commented Apr 14, 2023

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!

@sabine sabine marked this pull request as draft April 14, 2023 07:05
@art-w
Copy link

art-w commented Apr 17, 2023

Yes that makes sense!

  • The main issue for deployment with the existing dockerfile for ocaml.org is the ~9go database file that will need to be accessible.. Do we have some place where it could be hosted? (It's read-only, do we have access to a docker volume to avoid copying it in the container?)

    In the future, the plan is that voodoo will produce this database but we are not there yet! It would be nice if UI improvements/feedbacks could be worked on in parallel to the integration with the existing documentation pipeline.

  • Regarding official org, just let me know where I can move the repo! (or create an official fork if it's easier?) Changing the licence / Renaming sherlodoc is also up for grabs, for example odoc-search or whatever you see fit :)

    Note that this might be temporary: I have hope that the sherlodoc codebase will evaporate into odoc built-in support for search and that the initial project can be deprecated ^^

@sabine sabine force-pushed the integrate_sherlodoc_search branch from 0d73584 to 5cc7a8f Compare April 17, 2023 15:12
@tmattio
Copy link
Collaborator

tmattio commented Sep 27, 2023

With the work on adding search support in odoc, powered by sherlodoc, I suspect the plan has changed quite significantly.
I suggest we pick this up once search support has landed upstream, closing in the meantime.

@tmattio tmattio closed this Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants