docs icon indicating copy to clipboard operation
docs copied to clipboard

[BUG] Community edition filter breaks algolia.net search

Open hashworks opened this issue 2 months ago • 5 comments

Currently, the included agnolia.net search doesn't return any results. This is due to the edition: ["community"] filter in instantSearch.js.

What is the plan here? It would be great if the search either worked out of the box or if you could provide instructions in the README how one can host their own search backend.

hashworks avatar Oct 24 '25 13:10 hashworks

One can of course do something like this, but this just lists results of the enterprise documentation (and links to it).

Drop-broken-community-edition-search-filter.patch

From f7d0e1b249191071125313b77f250fab49078699 Mon Sep 17 00:00:00 2001
From: Justin Kromlinger <[email protected]>
Date: Fri, 24 Oct 2025 15:30:47 +0200
Subject: [PATCH] Drop broken community edition search filter

---
 source/_static/js/instantSearch.js | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/source/_static/js/instantSearch.js b/source/_static/js/instantSearch.js
index 61d2716..e7ba135 100644
--- a/source/_static/js/instantSearch.js
+++ b/source/_static/js/instantSearch.js
@@ -98,8 +98,7 @@ window.addEventListener("DOMContentLoaded", () => {
     initialUiState: {
       minio: {
         refinementList: {
-          site: ["docs"],
-          edition: ["community"],
+          site: ["docs"]
         },
       },
     },
@@ -268,7 +267,7 @@ window.addEventListener("DOMContentLoaded", () => {
       },
     }),
     instantsearch.widgets.configure({
-      filters: `site:docs AND edition:community`,
+      filters: `site:docs`,
     })
   ]);
 
-- 
2.51.1

hashworks avatar Oct 24 '25 13:10 hashworks

Hm - @rushenn it's been a while since I looked at this code, and we had built it around some faceting that no longer applies.

That said, I think this might just require replacing our app ID (https://github.com/minio/docs/blob/main/source/_static/js/instantSearch.js#L61-L65) with a placeholder + README directive.

@hashworks if you happen to have an Algolia app ID you could try to point it at your local hosted site and see if just replacing the app ID works.

The alternative would be to rip algolia entirely, as we aren't maintaining it moving forward and therefore cannot really provide any support if it breaks for local builds. That would revert to the built-in Sphinx search (https://github.com/minio/docs/commit/6423ebbd73183f32413480547b8044a5120fe72c#diff-eaafcc1ce3e260232d5a19b1ca12c6108671093c122201dcaf486cb08b2c715f ? )

ravindk89 avatar Oct 24 '25 16:10 ravindk89

if you happen to have an Algolia app ID you could try to point it at your local hosted site and see if just replacing the app ID works.

I don't think it's reasonable to expect users to use a 3rd party "AI search" for simple self-hosted docs.

The alternative would be to rip algolia entirely, as we aren't maintaining it moving forward and therefore cannot really provide any support if it breaks for local builds. That would revert to the built-in Sphinx search (https://github.com/minio/docs/commit/6423ebbd73183f32413480547b8044a5120fe72c#diff-eaafcc1ce3e260232d5a19b1ca12c6108671093c122201dcaf486cb08b2c715f ? )

I guess this means one has to run a python webserver for the docs which provides the search endpoint? Sounds fine to me.

hashworks avatar Oct 24 '25 18:10 hashworks

@ravindk89 Since we’re no longer maintaining it, I’d recommend removing Algolia search feature entirely.

rushenn avatar Oct 24 '25 18:10 rushenn

Agreed - @rushenn let's yank back to the stock Sphinx search

@hashworks effectively yes - python -m http.server would work, as would chucking the build output into /var/www/html

ravindk89 avatar Oct 24 '25 21:10 ravindk89