meta: Replace lunr (middleman-search) with DocSearch

[tnir]

Problems

The Bundler.io Website team needs to maintain our own search.js and search_arrow.js by themselves with that abandoned middleman-search (for example manastech/middleman-search#38) and its dependency of the legacy version lunr.js.

We cannot upgrade lunr to the latest without our efforts (or other community's efforts than maintainers).

This also prevents from merging #661.

Solutions

https://github.com/algolia/docsearch (do not confused with https://docsearch.algolia.com/) can be utilized.

Pros

• For open-source project, the cost is free.
• lunr-index.json is not required any more.
• The Bundler.io Website team can save time to maintain our own search.js and search_arrow.js
• UI components search.js and search_arrows.js can be replaced with Algolia's one, which seems sophisticated to me.
• We do not need to spend time for reinventing the wheel such as above.
• Fuzzy search by DocSearch is also nice.
• Loading index on every page (no cache on browser side as of writing) can be avoided.

Cons

• Proprietary (while no cost)

[deivid-rodriguez]

There's also typesense which describes itself as "The Open Source Algolia Alternative".

[tnir]

Yes, typesense cloud is not at no cost even for open source project while typesense software is fully open-sourced. DocSearch equips (user-facing) UI kit specialized for document search as its name suggests.

DocSearch (and Algolia in small amount) is to typesense cloud what GitHub is to GitLab. GitLab is an open-sourced project but (GitLab as cloud service) is getting less and less for open source project (a personal opinion).

Anyway, thanks for replying to my "Cons".

[simi]

Maybe we can ask typesense for some kind of "free" community program.

/cc @kishorenc

[kishorenc]

@simi We'll be delighted to help!

[tnir]

https://typesense.org/docs/guide/docsearch.html looks like getting started 😁

[tnir]

I implemented #702 with a 30-day free cluster (0.5 GB RAM, 2 vCPUs, 1 hr burst per day) on Typesense cloud associated with an account outside of @rubygems Org.

[tnir]

With a proof of concept in #702, at this moment I prefer Algolia's DocSearch as it is for free, provides automated crawling every 24 hours and new look and feel so-called as DocSearch v3...

[jasonbosco]

@tnir I work with @kishorenc on Typesense. DocSearch v3 also works with Typesense. Here’s one site that uses it: https://rushjs.io/.

Happy to also host the scraper for you, and set it up to crawl on-demand on each deploy, so the index is updated in near real-time. Let me know.

P.S.: I’m a big Ruby fan, the Typesense Cloud management console is built on Rails, so I’m very excited to be able to support the Ruby ecosystem in anyway I can!

[tnir]

@jasonbosco Thanks for your reply. While I could not find any clue about DocSearch v3-compatible typesense-docsearch.js npm package at https://github.com/microsoft/rushjs.io-website, how did rushjs team do it?

On development of this, I also found https://github.com/typesense/typesense-docsearch.js seems having no update more than 18 months 😭

Thanks for hosting the scraper, but can we monitor it like one at Algolia's crawler?

P.S. I was a (big) Typesense fan last summer. When I just logged in today 1 year after it, I found my personal account is disabled 😭.

[tnir]

@jasonbosco Two questions in summary:

1. How can I get Typesense DocSearch.js with DocSearch v3 compatible (modern UI)?
2. How will we get Typesense DocSearch.js compatible with latest DocSearch in future?
3. How can get an account for this case? rubygems namespace?

[jasonbosco]

@tnir

How can I get Typesense DocSearch.js with DocSearch v3 compatible (modern UI)?

Rushjs.io uses Docusaurus and so they use the Docusaurus Typesense theme, which in turn uses typesense-docsearch-react.

I haven't yet published a non-React version of typesense-docsearch v3. So we can do one of two things:

1. Use something like this with middleman: https://github.com/plasticine/middleman-react
2. I can look into publishing a vanilla JS of typesense-docsearch v3

Let me know which one you'd prefer.

How will we get Typesense DocSearch.js compatible with latest DocSearch in future?

I intend to maintain the Typesense fork of Docsearch well into the future, as new versions of Docsearch come out.

On development of this, I also found https://github.com/typesense/typesense-docsearch.js seems having no update more than 18 months 😭

The next branch of typesense-docsearch.js has more recent updates, which is the branch where Docsearch v3 also exists in upstream. Algolia just made the next branch as the default one in Github, whereas I left the default branch as is.

Thanks for hosting the scraper, but can we monitor it like one at Algolia's crawler?

We don't have a monitoring UI for the scraper specifically, but happy to share access to logs that the scraper generates.

When I just logged in today 1 year after it, I found my personal account is disabled
How can get an account for this case? rubygems namespace?

I've gone ahead and reinstated your account.

In any case, you would want to provision clusters under a team account in case cluster access needs to be shared. The best way to do this would be to create a new (free) Github Org just for this purpose call it say rubygems-typesense, and add anyone who needs access to the cluster to this org. When anyone who is a member of this Github org logins to Typesense Cloud via Github, they will then have access to this cluster.

Alternatively, you could also authorize access to the rubygems org when logging into Typesense Cloud, and then from the Typesense Cloud account page, specify a particular Github team within the rubygems Github org who would need access to Typesense Cloud.

To reauthorize your own account, you want to visit https://github.com/settings/applications, remove Typesense Cloud and then log out and log back in to Typesense Cloud. Github will then prompt you to allow access to the new Github org.